| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
certificate_arn
string
-
- |
- - | -
- If provided, the results will be filtered to show only the certificate with this ARN.
- If no certificate with this ARN exists, this task will fail.
- If a certificate with this ARN exists in a different region, this task will fail
- aliases: arn |
+
+
+ + | +
+ If provided, the results will be filtered to show only the certificate with this ARN.
+ If no certificate with this ARN exists, this task will fail.
+ If a certificate with this ARN exists in a different region, this task will fail
+ aliases: arn |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
domain_name
string
-
- |
- - | -
- The domain name of an ACM certificate to limit the search to
- aliases: name |
+
+
+ + | +
+ The domain name of an ACM certificate to limit the search to
+ aliases: name |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
statuses
list
- / elements=string
- |
-
-
|
-
- Status to filter the certificate results
- |
- ||
| + / elements=string + | +
+
|
+
+ Status to filter the certificate results
+ |
+ ||
|
tags
dictionary
-
- |
- - | -
- Filter results to show only certificates with tags that match all the tags specified here.
- |
+
+
+ + | +
+ Filter results to show only certificates with tags that match all the tags specified here.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
-
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
certificate
string
-
- |
- - | -
- The body of the PEM encoded public certificate.
- Required when state is not
- absent.If your certificate is in a file, use
- lookup('file', 'path/to/cert.pem'). |
+
+
+ + | +
+ The body of the PEM encoded public certificate.
+ Required when state is not
+ absent.If your certificate is in a file, use
+ lookup('file', 'path/to/cert.pem'). |
| + | ||||
|
certificate_arn
string
-
- |
- - | -
- The ARN of a certificate in ACM to delete
- Ignored when state=present.
- If state=absent, you must provide one of certificate_arn, domain_name or name_tag.
- If state=absent and no resource exists with this ARN in this region, the task will succeed with no effect.
- If state=absent and the corresponding resource exists in a different region, this task may report success without deleting that resource.
- aliases: arn |
+
+
+ + | +
+ The ARN of a certificate in ACM to delete
+ Ignored when state=present.
+ If state=absent, you must provide one of certificate_arn, domain_name or name_tag.
+ If state=absent and no resource exists with this ARN in this region, the task will succeed with no effect.
+ If state=absent and the corresponding resource exists in a different region, this task may report success without deleting that resource.
+ aliases: arn |
| + | ||||
|
certificate_chain
string
-
- |
- - | -
- The body of the PEM encoded chain for your certificate.
- If your certificate chain is in a file, use
- lookup('file', 'path/to/chain.pem').Ignored when state=absent
- |
+
+
+ + | +
+ The body of the PEM encoded chain for your certificate.
+ If your certificate chain is in a file, use
+ lookup('file', 'path/to/chain.pem').Ignored when state=absent
+ |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
domain_name
string
-
- |
- - | -
- The domain name of the certificate.
- If state=absent and domain_name is specified, this task will delete all ACM certificates with this domain.
- Exactly one of domain_name, name_tag and certificate_arn must be provided.
- If state=present this must not be specified. (Since the domain name is encoded within the public certificate's body.)
- aliases: domain |
+
+
+ + | +
+ The domain name of the certificate.
+ If state=absent and domain_name is specified, this task will delete all ACM certificates with this domain.
+ Exactly one of domain_name, name_tag and certificate_arn must be provided.
+ If state=present this must not be specified. (Since the domain name is encoded within the public certificate's body.)
+ aliases: domain |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
name_tag
string
-
- |
- - | -
- The unique identifier for tagging resources using AWS tags, with key Name.
- This can be any set of characters accepted by AWS for tag values.
- This is to ensure Ansible can treat certificates idempotently, even though the ACM API allows duplicate certificates.
- If state=preset, this must be specified.
- If state=absent, you must provide exactly one of certificate_arn, domain_name or name_tag.
- aliases: name |
+
+
+ + | +
+ The unique identifier for tagging resources using AWS tags, with key Name.
+ This can be any set of characters accepted by AWS for tag values.
+ This is to ensure Ansible can treat certificates idempotently, even though the ACM API allows duplicate certificates.
+ If state=preset, this must be specified.
+ If state=absent, you must provide exactly one of certificate_arn, domain_name or name_tag.
+ aliases: name |
| + | ||||
|
private_key
string
-
- |
- - | -
- The body of the PEM encoded private key.
- Required when state=present.
- Ignored when state=absent.
- If your private key is in a file, use
- lookup('file', 'path/to/key.pem'). |
+
+
+ + | +
+ The body of the PEM encoded private key.
+ Required when state=present.
+ Ignored when state=absent.
+ If your private key is in a file, use
+ lookup('file', 'path/to/key.pem'). |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- If state=present, the specified public certificate and private key will be uploaded, with Name tag equal to name_tag.
- If state=absent, any certificates in this region with a corresponding domain_name, name_tag or certificate_arn will be deleted.
- |
+
+
+
+
|
+
+ If state=present, the specified public certificate and private key will be uploaded, with Name tag equal to name_tag.
+ If state=absent, any certificates in this region with a corresponding domain_name, name_tag or certificate_arn will be deleted.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
api_id
string
-
- |
- - | -
- The ID of the API you want to manage.
- |
+
+
+ + | +
+ The ID of the API you want to manage.
+ |
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
cache_enabled
boolean
-
- |
-
-
|
-
- Enable API GW caching of backend responses. Defaults to false.
- |
+
+
+
+
|
+
+ Enable API GW caching of backend responses. Defaults to false.
+ |
| + | ||||
|
cache_size
string
-
- |
-
-
|
-
- Size in GB of the API GW cache, becomes effective when cache_enabled is true.
- |
+
+
+
+
|
+
+ Size in GB of the API GW cache, becomes effective when cache_enabled is true.
+ |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
deploy_desc
string
-
- |
-
- Default: "Automatic deployment by Ansible."
- |
-
- Description of the deployment - recorded and visible in the AWS console.
- |
+
+
+
+ Default: "Automatic deployment by Ansible."
+ |
+
+ Description of the deployment - recorded and visible in the AWS console.
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
endpoint_type
string
-
- |
-
-
|
-
- Type of endpoint configuration, use
- EDGE for an edge optimized API endpoint,REGIONAL for just a regional deploy or PRIVATE for a private API.This will flag will only be used when creating a new API Gateway setup, not for updates.
- |
+
+
+
+
|
+
+ Type of endpoint configuration, use
+ EDGE for an edge optimized API endpoint,REGIONAL for just a regional deploy or PRIVATE for a private API.This will flag will only be used when creating a new API Gateway setup, not for updates.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
stage
string
-
- |
- - | -
- The name of the stage the API should be deployed to.
- |
+
+
+ + | +
+ The name of the stage the API should be deployed to.
+ |
| + | ||||
|
stage_canary_settings
dictionary
-
- |
- - | -
- Canary settings for the deployment of the stage.
- Dict with following settings:
- percentTraffic: The percent (0-100) of traffic diverted to a canary deployment.
- deploymentId: The ID of the canary deployment.
- stageVariableOverrides: Stage variables overridden for a canary release deployment.
- useStageCache: A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
-
- |
+
+
+ + | +
+ Canary settings for the deployment of the stage.
+ Dict with following settings:
+ percentTraffic: The percent (0-100) of traffic diverted to a canary deployment.
+ deploymentId: The ID of the canary deployment.
+ stageVariableOverrides: Stage variables overridden for a canary release deployment.
+ useStageCache: A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
+
+ |
| + | ||||
|
stage_variables
dictionary
-
- |
- - | -
- ENV variables for the stage. Define a dict of key values pairs for variables.
- |
+
+
+ + | +
+ ENV variables for the stage. Define a dict of key values pairs for variables.
+ |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Create or delete API Gateway.
- |
+
+
+
+
|
+
+ Create or delete API Gateway.
+ |
| + | ||||
|
swagger_dict
json
-
- |
- - | -
- Swagger definitions API ansible dictionary which will be converted to JSON and uploaded.
- |
+
+
+ + | +
+ Swagger definitions API ansible dictionary which will be converted to JSON and uploaded.
+ |
| + | ||||
|
swagger_file
path
-
- |
- - | -
- JSON or YAML file containing swagger definitions for API. Exactly one of swagger_file, swagger_text or swagger_dict must be present.
- aliases: src, api_file |
+
+
+ + | +
+ JSON or YAML file containing swagger definitions for API. Exactly one of swagger_file, swagger_text or swagger_dict must be present.
+ aliases: src, api_file |
| + | ||||
|
swagger_text
string
-
- |
- - | -
- Swagger definitions for API in JSON or YAML as a string direct from playbook.
- |
+
+
+ + | +
+ Swagger definitions for API in JSON or YAML as a string direct from playbook.
+ |
| + | ||||
|
tracing_enabled
boolean
-
- |
-
-
|
-
- Specifies whether active tracing with X-ray is enabled for the API GW stage.
- |
+
+
+
+
|
+
+ Specifies whether active tracing with X-ray is enabled for the API GW stage.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
maximum_tasks
integer
-
- |
- - | -
- The maximum value to scale to in response to a scale out event. This parameter is required if you are creating a first new policy for the specified service.
- |
+
+
+ + | +
+ The maximum value to scale to in response to a scale out event. This parameter is required if you are creating a first new policy for the specified service.
+ |
|
| + | |||||
|
minimum_tasks
integer
-
- |
- - | -
- The minimum value to scale to in response to a scale in event. This parameter is required if you are creating a first new policy for the specified service.
- |
+
+
+ + | +
+ The minimum value to scale to in response to a scale in event. This parameter is required if you are creating a first new policy for the specified service.
+ |
|
| + | |||||
|
override_task_capacity
boolean
-
- |
-
-
|
-
- Whether or not to override values of minimum and/or maximum tasks if it's already set.
- |
+
+
+
+
|
+
+ Whether or not to override values of minimum and/or maximum tasks if it's already set.
+ |
|
| + | |||||
|
policy_name
string
- / required
- |
- - | -
- The name of the scaling policy.
- |
+ / required
+
+ + | +
+ The name of the scaling policy.
+ |
|
| + | |||||
|
policy_type
string
- / required
- |
-
-
|
-
- The policy type.
- |
+ / required
+
+
+
|
+
+ The policy type.
+ |
|
| + | |||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
resource_id
string
- / required
- |
- - | -
- The identifier of the resource associated with the scalable target.
- |
+ / required
+
+ + | +
+ The identifier of the resource associated with the scalable target.
+ |
|
| + | |||||
|
scalable_dimension
string
- / required
- |
-
-
|
-
- The scalable dimension associated with the scalable target.
- |
+ / required
+
+
+
|
+
+ The scalable dimension associated with the scalable target.
+ |
|
| + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
service_namespace
string
- / required
- |
-
-
|
-
- The namespace of the AWS service.
- |
+ / required
+
+
+
|
+
+ The namespace of the AWS service.
+ |
|
| + | |||||
|
state
string
- / required
- |
-
-
|
-
- Whether a policy should be present or absent
- |
+ / required
+
+
+
|
+
+ Whether a policy should be present or absent
+ |
|
| + | |||||
|
step_scaling_policy_configuration
dictionary
-
- |
- - | -
- A step scaling policy. This parameter is required if you are creating a policy and the policy type is StepScaling.
- |
+
+
+ + | +
+ A step scaling policy. This parameter is required if you are creating a policy and the policy type is StepScaling.
+ |
|
| + | |||||
|
target_tracking_scaling_policy_configuration
dictionary
-
- |
- - | -
- A target tracking policy. This parameter is required if you are creating a new policy and the policy type is TargetTrackingScaling.
- Full documentation of the suboptions can be found in the API documentation:
-
- |
- |||
| - | + + | ++ | +
+ A target tracking policy. This parameter is required if you are creating a new policy and the policy type is TargetTrackingScaling.
+ Full documentation of the suboptions can be found in the API documentation:
+
+ |
+ ||
| + |
CustomizedMetricSpecification
dictionary
-
- |
- - | -
- The metric to use if using a customized metric.
- |
+
+
+ + | +
+ The metric to use if using a customized metric.
+ |
| - | + | ||||
| + |
DisableScaleIn
boolean
-
- |
-
-
|
-
- Whether scaling-in should be disabled.
- |
+
+
+
+
|
+
+ Whether scaling-in should be disabled.
+ |
| - | + | ||||
| + |
PredefinedMetricSpecification
dictionary
-
- |
- - | -
- The metric to use if using a predefined metric.
- |
+
+
+ + | +
+ The metric to use if using a predefined metric.
+ |
| - | + | ||||
| + |
ScaleInCooldown
integer
-
- |
- - | -
- The time (in seconds) to wait after scaling-in before another scaling action can occur.
- |
+
+
+ + | +
+ The time (in seconds) to wait after scaling-in before another scaling action can occur.
+ |
| - | + | ||||
| + |
ScaleOutCooldown
integer
-
- |
- - | -
- The time (in seconds) to wait after scaling-out before another scaling action can occur.
- |
+
+
+ + | +
+ The time (in seconds) to wait after scaling-out before another scaling action can occur.
+ |
| - | + | ||||
| + |
TargetValue
float
-
- |
- - | -
- The target value for the metric
- |
- ||
| + + | ++ | +
+ The target value for the metric
+ |
+ |||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
- |||
present.present.present.present.present.present.| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
bid_percentage
integer
-
- |
- - | -
- The minimum percentage that a Spot Instance price must be when compared with the On-Demand price for that instance type before instances are launched. For example, if your bid percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance.
- |
+
+
+ + | +
+ The minimum percentage that a Spot Instance price must be when compared with the On-Demand price for that instance type before instances are launched.
+ For example, if your bid percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance.
+ |
| + | ||||
|
compute_environment_name
string
- / required
- |
- - | -
- The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed.
- |
+ / required
+
+ + | +
+ The name for your compute environment.
+ Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed.
+ |
| + | ||||
|
compute_environment_state
string
-
- |
-
-
|
-
- The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.
- |
+
+
+
+
|
+
+ The state of the compute environment.
+ If the state is
+ ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues. |
| + | ||||
|
compute_resource_type
string
- / required
- |
-
-
|
-
- The type of compute resource.
- |
+ / required
+
+
+
|
+
+ The type of compute resource.
+ |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
desiredv_cpus
integer
-
- |
- - | -
- The desired number of EC2 vCPUS in the compute environment.
- |
+
+
+ + | +
+ The desired number of EC2 vCPUS in the compute environment.
+ |
| + | ||||
|
ec2_key_pair
string
-
- |
- - | -
- The EC2 key pair that is used for instances launched in the compute environment.
- |
+
+
+ + | +
+ The EC2 key pair that is used for instances launched in the compute environment.
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
image_id
string
-
- |
- - | -
- The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
- |
+
+
+ + | +
+ The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
+ |
| + | ||||
|
instance_role
string
- / required
- |
- - | -
- The Amazon ECS instance role applied to Amazon EC2 instances in a compute environment.
- |
+ / required
+
+ + | +
+ The Amazon ECS instance role applied to Amazon EC2 instances in a compute environment.
+ |
| + | ||||
|
instance_types
list
- / elements=string / required
- |
- - | -
- The instance types that may be launched.
- |
+ / elements=string / required
+
+ + | +
+ The instance types that may be launched.
+ |
| + | ||||
|
maxv_cpus
integer
- / required
- |
- - | -
- The maximum number of EC2 vCPUs that an environment can reach.
- |
+ / required
+
+ + | +
+ The maximum number of EC2 vCPUs that an environment can reach.
+ |
| + | ||||
|
minv_cpus
integer
- / required
- |
- - | -
- The minimum number of EC2 vCPUs that an environment should maintain.
- |
+ / required
+
+ + | +
+ The minimum number of EC2 vCPUs that an environment should maintain.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
security_group_ids
list
- / elements=string / required
- |
- - | -
- The EC2 security groups that are associated with instances launched in the compute environment.
- |
+ / elements=string / required
+
+ + | +
+ The EC2 security groups that are associated with instances launched in the compute environment.
+ |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
service_role
string
- / required
- |
- - | -
- The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.
- |
+ / required
+
+ + | +
+ The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.
+ |
| + | ||||
|
spot_iam_fleet_role
string
-
- |
- - | -
- The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.
- |
+
+
+ + | +
+ The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.
+ |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Describes the desired state.
- |
+
+
+
+
|
+
+ Describes the desired state.
+ |
| + | ||||
|
subnets
list
- / elements=string / required
- |
- - | -
- The VPC subnets into which the compute resources are launched.
- |
+ / elements=string / required
+
+ + | +
+ The VPC subnets into which the compute resources are launched.
+ |
| + | ||||
|
tags
dictionary
-
- |
- - | -
- Key-value pair tags to be applied to resources that are launched in the compute environment.
- |
+
+
+ + | +
+ Key-value pair tags to be applied to resources that are launched in the compute environment.
+ |
| + | ||||
|
type
string
- / required
- |
-
-
|
-
- The type of the compute environment.
- |
+ / required
+
+
+
|
+
+ The type of the compute environment.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
attempts
integer
-
- |
- - | -
- Retry strategy - The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If attempts is greater than one, the job is retried if it fails until it has moved to RUNNABLE that many times.
- |
+
+
+ + | +
+ Retry strategy - The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If attempts is greater than one, the job is retried if it fails until it has moved to RUNNABLE that many times.
+ |
|
| + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
command
list
- / elements=string
- |
- - | -
- The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.
- |
+ / elements=string
+
+ + | +
+ The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.
+ |
|
| + | |||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
environment
list
- / elements=dictionary
- |
- - | -
- The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.
- |
- |||
| - | + / elements=dictionary + | ++ | +
+ The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.
+ |
+ ||
| + |
name
-
-
- |
- - | -
- The name of the key value pair. For environment variables, this is the name of the environment variable.
- |
+
+
+ + | +
+ The name of the key value pair. For environment variables, this is the name of the environment variable.
+ |
| - | + | ||||
| + |
value
-
-
- |
- - | -
- The value of the key value pair. For environment variables, this is the value of the environment variable.
- |
- ||
| + + | ++ | +
+ The value of the key value pair. For environment variables, this is the value of the environment variable.
+ |
+ |||
|
image
string
- / required
- |
- - | -
- The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with `` repository-url /image <colon>tag ``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
- |
+ / required
+
+ + | +
+ The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with `` repository-url /image <colon>tag ``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
+ |
|
| + | |||||
|
job_definition_arn
string
-
- |
- - | -
- The ARN for the job definition.
- |
+
+
+ + | +
+ The ARN for the job definition.
+ |
|
| + | |||||
|
job_definition_name
string
- / required
- |
- - | -
- The name for the job definition.
- |
+ / required
+
+ + | +
+ The name for the job definition.
+ |
|
| + | |||||
|
job_role_arn
string
-
- |
- - | -
- The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
- |
+
+
+ + | +
+ The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
+ |
|
| + | |||||
|
memory
integer
- / required
- |
- - | -
- The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
- |
+ / required
+
+ + | +
+ The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.
+ |
|
| + | |||||
|
mount_points
list
- / elements=dictionary
- |
- - | -
- The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
- |
- |||
| - | + / elements=dictionary + | ++ | +
+ The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
+ |
+ ||
| + |
containerPath
-
-
- |
- - | -
- The path on the container at which to mount the host volume.
- |
+
+
+ + | +
+ The path on the container at which to mount the host volume.
+ |
| - | + | ||||
| + |
readOnly
-
-
- |
- - | -
- If this value is true , the container has read-only access to the volume; otherwise, the container can write to the volume. The default value is
- false. |
+
+
+ + | +
+ If this value is true , the container has read-only access to the volume; otherwise, the container can write to the volume. The default value is
+ false. |
| - | + | ||||
| + |
sourceVolume
-
-
- |
- - | -
- The name of the volume to mount.
- |
- ||
| + + | ++ | +
+ The name of the volume to mount.
+ |
+ |||
|
parameters
dictionary
-
- |
- - | -
- Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.
- |
+
+
+ + | +
+ Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.
+ |
|
| + | |||||
|
privileged
string
-
- |
- - | -
- When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.
- |
+
+
+ + | +
+ When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.
+ |
|
| + | |||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
readonly_root_filesystem
string
-
- |
- - | -
- When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.
- |
+
+
+ + | +
+ When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.
+ |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
state
string
-
- |
-
-
|
-
- Describes the desired state.
- |
+
+
+
+
|
+
+ Describes the desired state.
+ |
|
| + | |||||
|
type
string
- / required
- |
- - | -
- The type of job definition.
- |
+ / required
+
+ + | +
+ The type of job definition.
+ |
|
| + | |||||
|
ulimits
list
- / elements=dictionary
- |
- - | -
- A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
- |
- |||
| - | + / elements=dictionary + | ++ | +
+ A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
+ |
+ ||
| + |
hardLimit
-
-
- |
- - | -
- The hard limit for the ulimit type.
- |
+
+
+ + | +
+ The hard limit for the ulimit type.
+ |
| - | + | ||||
| + |
name
-
-
- |
- - | -
- The type of the ulimit.
- |
+
+
+ + | +
+ The type of the ulimit.
+ |
| - | + | ||||
| + |
softLimit
-
-
- |
- - | -
- The soft limit for the ulimit type.
- |
- ||
| + + | ++ | +
+ The soft limit for the ulimit type.
+ |
+ |||
|
user
string
-
- |
- - | -
- The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
- |
+
+
+ + | +
+ The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
+ |
|
| + | |||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
|
| + | |||||
|
vcpus
integer
- / required
- |
- - | -
- The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares.
- |
+ / required
+
+ + | +
+ The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares.
+ |
|
| + | |||||
|
volumes
list
- / elements=dictionary
- |
- - | -
- A list of data volumes used in a job.
- |
- |||
| - | + / elements=dictionary + | ++ | +
+ A list of data volumes used in a job.
+ |
+ ||
| + |
host
-
-
- |
- - | -
- The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running. This is a dictionary with one property, sourcePath - The path on the host container instance that is presented to the container. If this parameter is empty,then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
- |
+
+
+ + | +
+ The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running. This is a dictionary with one property, sourcePath - The path on the host container instance that is presented to the container. If this parameter is empty,then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
+ |
| - | + | ||||
| + |
name
-
-
- |
- - | -
- The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.
- |
- ||
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
compute_environment_order
list
- / elements=dictionary / required
- |
- - | -
- The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should execute a given job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to 3 compute environments with a job queue.
- |
+ / elements=dictionary / required
+
+ + | +
+ The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should execute a given job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to 3 compute environments with a job queue.
+ |
|
| - | + | ||||
| + |
compute_environment
string
-
- |
- - | -
- The name of the compute environment.
- |
+
+
+ + | +
+ The name of the compute environment.
+ |
| - | + | ||||
| + |
order
integer
-
- |
- - | -
- The relative priority of the environment.
- |
+
+
+ + | +
+ The relative priority of the environment.
+ |
| + + | |||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
job_queue_name
string
- / required
- |
- - | -
- The name for the job queue
- |
+ / required
+
+ + | +
+ The name for the job queue
+ |
|
| + | |||||
|
job_queue_state
string
-
- |
-
-
|
-
- The state of the job queue. If the job queue state is ENABLED , it is able to accept jobs.
- |
+
+
+
+
|
+
+ The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs.
+ |
|
| + | |||||
|
priority
integer
- / required
- |
- - | -
- The priority of the job queue. Job queues with a higher priority (or a lower integer value for the priority parameter) are evaluated first when associated with same compute environment. Priority is determined in ascending order, for example, a job queue with a priority value of 1 is given scheduling preference over a job queue with a priority value of 10.
- |
+ / required
+
+ + | +
+ The priority of the job queue. Job queues with a higher priority (or a lower integer value for the priority parameter) are evaluated first when associated with same compute environment. Priority is determined in ascending order, for example, a job queue with a priority value of 1 is given scheduling preference over a job queue with a priority value of 10.
+ |
|
| + | |||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
state
string
-
- |
-
-
|
-
- Describes the desired state.
- |
+
+
+
+
|
+
+ Describes the desired state.
+ |
|
| + | |||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
|
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
artifacts
dictionary
- / required
- |
- - | -
- Information about the build output artifacts for the build project.
- |
+ / required
+
+ + | +
+ Information about the build output artifacts for the build project.
+ |
|
| - | + | ||||
| + |
location
-
-
- |
- - | -
- Information about the build output artifact location. When choosing type S3, set the bucket name here.
- |
+
+
+ + | +
+ Information about the build output artifact location. When choosing type S3, set the bucket name here.
+ |
| - | + | ||||
| + |
name
-
-
- |
- - | -
- Along with path and namespace_type, the pattern that AWS CodeBuild will use to name and store the output artifact.
- |
+
+
+ + | +
+ Along with path and namespace_type, the pattern that AWS CodeBuild will use to name and store the output artifact.
+ |
| - | + | ||||
| + |
namespace_type
-
-
- |
- - | -
- Along with path and name, the pattern that AWS CodeBuild will use to determine the name and location to store the output artifacts.
- Accepts
-
- BUILD_ID and NONE. |
+
+
+ + | +
+ Along with path and name, the pattern that AWS CodeBuild will use to determine the name and location to store the output artifacts.
+ Accepts
+
+ BUILD_ID and NONE. |
| - | + | ||||
| + |
packaging
-
-
- |
- - | -
- The type of build output artifact to create on S3, can be NONE for creating a folder or ZIP for a ZIP file.
- |
+
+
+ + | +
+ The type of build output artifact to create on S3, can be NONE for creating a folder or ZIP for a ZIP file.
+ |
| - | + | ||||
| + |
path
-
-
- |
- - | -
- Along with namespace_type and name, the pattern that AWS CodeBuild will use to name and store the output artifacts.
- Used for path in S3 bucket when type is
- S3. |
+
+
+ + | +
+ Along with namespace_type and name, the pattern that AWS CodeBuild will use to name and store the output artifacts.
+ Used for path in S3 bucket when type is
+ S3. |
| - | + | ||||
| + |
type
-
- / required
- |
- - | -
- The type of build output for artifacts. Can be one of the following:
- CODEPIPELINE, NO_ARTIFACTS, S3. |
+ / required
+
+ + | +
+ The type of build output for artifacts. Can be one of the following:
+ CODEPIPELINE, NO_ARTIFACTS, S3. |
| + + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
cache
dictionary
-
- |
- - | -
- Caching params to speed up following builds.
- |
+
+
+ + | +
+ Caching params to speed up following builds.
+ |
|
| - | + | ||||
| + |
location
-
- / required
- |
- - | -
- Caching location on S3.
- |
+ / required
+
+ + | +
+ Caching location on S3.
+ |
| - | + | ||||
| + |
type
-
- / required
- |
- - | -
- Cache type. Can be
- NO_CACHE or S3. |
+ / required
+
+ + | +
+ Cache type. Can be
+ NO_CACHE or S3. |
| + + | |||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
|
| + | |||||
|
description
string
-
- |
- - | -
- Descriptive text of the CodeBuild project.
- |
+
+
+ + | +
+ Descriptive text of the CodeBuild project.
+ |
|
| + | |||||
|
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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
encryption_key
string
-
- |
- - | -
- The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.
- |
+
+
+ + | +
+ The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.
+ |
|
| + | |||||
|
environment
dictionary
-
- |
- - | -
- Information about the build environment for the build project.
- |
+
+
+ + | +
+ Information about the build environment for the build project.
+ |
|
| - | + | ||||
| + |
compute_type
-
- / required
- |
- - | -
- Information about the compute resources the build project will use.
- Available values include:
- BUILD_GENERAL1_SMALL, BUILD_GENERAL1_MEDIUM, BUILD_GENERAL1_LARGE. |
+ / required
+
+ + | +
+ Information about the compute resources the build project will use.
+ Available values include:
+ BUILD_GENERAL1_SMALL, BUILD_GENERAL1_MEDIUM, BUILD_GENERAL1_LARGE. |
| - | + | ||||
| + |
environment_variables
-
-
- |
- - | -
- A set of environment variables to make available to builds for the build project. List of dictionaries with name and value fields.
- Example: { name: 'MY_ENV_VARIABLE', value: 'test' }
- |
+
+
+ + | +
+ A set of environment variables to make available to builds for the build project. List of dictionaries with name and value fields.
+ Example: { name: 'MY_ENV_VARIABLE', value: 'test' }
+ |
| - | + | ||||
| + |
image
-
- / required
- |
- - | -
- The ID of the Docker image to use for this build project.
- |
+ / required
+
+ + | +
+ The ID of the Docker image to use for this build project.
+ |
| - | + | ||||
| + |
privileged_mode
-
-
- |
- - | -
- Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images.
- |
+
+
+ + | +
+ Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images.
+ |
| - | + | ||||
| + |
type
-
- / required
- |
- - | -
- The type of build environment to use for the project. Usually
- LINUX_CONTAINER. |
+ / required
+
+ + | +
+ The type of build environment to use for the project. Usually
+ LINUX_CONTAINER. |
| + + | |||||
|
name
string
- / required
- |
- - | -
- Name of the CodeBuild project.
- |
+ / required
+
+ + | +
+ Name of the CodeBuild project.
+ |
|
| + | |||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
service_role
string
-
- |
- - | -
- The ARN of the AWS IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
- |
+
+
+ + | +
+ The ARN of the AWS IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
+ |
|
| + | |||||
|
source
dictionary
- / required
- |
- - | -
- Configure service and location for the build input source.
- |
+ / required
+
+ + | +
+ Configure service and location for the build input source.
+ |
|
| - | + | ||||
| + |
buildspec
string
-
- |
- - | -
- The build spec declaration to use for the builds in this build project. Leave empty if part of the code project.
- |
+
+
+ + | +
+ The build spec declaration to use for the builds in this build project. Leave empty if part of the code project.
+ |
| - | + | ||||
| + |
git_clone_depth
integer
-
- |
- - | -
- When using git you can specify the clone depth as an integer here.
- |
+
+
+ + | +
+ When using git you can specify the clone depth as an integer here.
+ |
| - | + | ||||
| + |
insecure_ssl
boolean
-
- |
-
-
|
-
- Enable this flag to ignore SSL warnings while connecting to the project source code.
- |
+
+
+
+
|
+
+ Enable this flag to ignore SSL warnings while connecting to the project source code.
+ |
| - | + | ||||
| + |
location
string
-
- |
- - | -
- Information about the location of the source code to be built. For type CODEPIPELINE location should not be specified.
- |
+
+
+ + | +
+ Information about the location of the source code to be built. For type CODEPIPELINE location should not be specified.
+ |
| - | + | ||||
| + |
type
string
- / required
- |
- - | -
- The type of the source. Allows one of these:
- CODECOMMIT, CODEPIPELINE, GITHUB, S3, BITBUCKET, GITHUB_ENTERPRISE. |
+ / required
+
+ + | +
+ The type of the source. Allows one of these:
+ CODECOMMIT, CODEPIPELINE, GITHUB, S3, BITBUCKET, GITHUB_ENTERPRISE. |
| + + | |||||
|
state
string
-
- |
-
-
|
-
- Create or remove code build project.
- |
+
+
+
+
|
+
+ Create or remove code build project.
+ |
|
| + | |||||
|
tags
list
- / elements=dictionary
- |
- - | -
- A set of tags for the build project.
- |
+ / elements=dictionary
+
+ + | +
+ A set of tags for the build project.
+ |
|
| - | + | ||||
| + |
key
string
-
- |
- - | -
- The name of the Tag.
- |
+
+
+ + | +
+ The name of the Tag.
+ |
| - | + | ||||
| + |
value
string
-
- |
- - | -
- The value of the Tag.
- |
+
+
+ + | +
+ The value of the Tag.
+ |
| + + | |||||
|
timeout_in_minutes
integer
-
- |
-
- Default: 60
- |
-
- How long CodeBuild should wait until timing out any build that has not been marked as completed.
- |
+
+
+
+ Default: 60
+ |
+
+ How long CodeBuild should wait until timing out any build that has not been marked as completed.
+ |
|
| + | |||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
|
| + | |||||
|
vpc_config
dictionary
-
- |
- - | -
- The VPC config enables AWS CodeBuild to access resources in an Amazon VPC.
- |
+
+
+ + | +
+ The VPC config enables AWS CodeBuild to access resources in an Amazon VPC.
+ |
|
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
description
string
-
- |
- - | -
- description or comment of repository.
- aliases: comment |
+
+
+ + | +
+ description or comment of repository.
+ aliases: comment |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
name
string
- / required
- |
- - | -
- name of repository.
- |
+ / required
+
+ + | +
+ name of repository.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
- / required
- |
-
-
|
-
- Specifies the state of repository.
- |
+ / required
+
+
+
|
+
+ Specifies the state of repository.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
artifact_store
dictionary
- / required
- |
- - | -
- Location information where artifacts are stored (on S3). Dictionary with fields type and location.
- |
+ / required
+
+ + | +
+ Location information where artifacts are stored (on S3). Dictionary with fields type and location.
+ |
|
| - | + | ||||
| + |
location
string
-
- |
- - | -
- Bucket name for artifacts.
- |
+
+
+ + | +
+ Bucket name for artifacts.
+ |
| - | + | ||||
| + |
type
string
-
- |
- - | -
- Type of the artifacts storage (only 'S3' is currently supported).
- |
+
+
+ + | +
+ Type of the artifacts storage (only 'S3' is currently supported).
+ |
| + + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
name
string
- / required
- |
- - | -
- Name of the pipeline
- |
+ / required
+
+ + | +
+ Name of the pipeline
+ |
|
| + | |||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
role_arn
string
- / required
- |
- - | -
- ARN of the IAM role to use when executing the pipeline
- |
+ / required
+
+ + | +
+ ARN of the IAM role to use when executing the pipeline
+ |
|
| + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
stages
list
- / elements=dictionary / required
- |
- - | -
- List of stages to perform in the CodePipeline. List of dictionaries containing name and actions for each stage.
- |
+ / elements=dictionary / required
+
+ + | +
+ List of stages to perform in the CodePipeline. List of dictionaries containing name and actions for each stage.
+ |
|
| - | + | ||||
| + |
actions
list
- / elements=dictionary
- |
- - | -
- List of action configurations for that stage.
- See the boto3 documentation for full documentation of suboptions:
-
- |
+ / elements=dictionary
+
+ + | +
+ List of action configurations for that stage.
+ See the boto3 documentation for full documentation of suboptions:
+
+ |
| - | + | ||||
| + |
name
string
-
- |
- - | -
- Name of the stage (step) in the codepipeline
- |
+
+
+ + | +
+ Name of the stage (step) in the codepipeline
+ |
| + + | |||||
|
state
string
-
- |
-
-
|
-
- Create or remove code pipeline
- |
+
+
+
+
|
+
+ Create or remove code pipeline
+ |
|
| + | |||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
|
| + | |||||
|
version
integer
-
- |
- - | -
- Version number of the pipeline. This number is automatically incremented when a pipeline is updated.
- |
+
+
+ + | +
+ Version number of the pipeline. This number is automatically incremented when a pipeline is updated.
+ |
|
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
authorized_account_id
string
- / required
- |
- - | -
- The 12-digit account ID of the account authorized to aggregate data.
- |
+ / required
+
+ + | +
+ The 12-digit account ID of the account authorized to aggregate data.
+ |
| + | ||||
|
authorized_aws_region
string
- / required
- |
- - | -
- The region authorized to collect aggregated data.
- |
+ / required
+
+ + | +
+ The region authorized to collect aggregated data.
+ |
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Whether the Config rule should be present or absent.
- |
+
+
+
+
|
+
+ Whether the Config rule should be present or absent.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
account_sources
list
- / elements=dictionary / required
- |
- - | -
- Provides a list of source accounts and regions to be aggregated.
- |
+ / elements=dictionary / required
+
+ + | +
+ Provides a list of source accounts and regions to be aggregated.
+ |
|
| - | + | ||||
| + |
account_ids
list
- / elements=string
- |
- - | -
- A list of 12-digit account IDs of accounts being aggregated.
- |
+ / elements=string
+
+ + | +
+ A list of 12-digit account IDs of accounts being aggregated.
+ |
| - | + | ||||
| + |
all_aws_regions
boolean
-
- |
-
-
|
-
- If true, aggregate existing AWS Config regions and future regions.
- |
+
+
+
+
|
+
+ If true, aggregate existing AWS Config regions and future regions.
+ |
| - | + | ||||
| + |
aws_regions
list
- / elements=string
- |
- - | -
- A list of source regions being aggregated.
- |
+ / elements=string
+
+ + | +
+ A list of source regions being aggregated.
+ |
| + + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
name
string
- / required
- |
- - | -
- The name of the AWS Config resource.
- |
+ / required
+
+ + | +
+ The name of the AWS Config resource.
+ |
|
| + | |||||
|
organization_source
dictionary
- / required
- |
- - | -
- The region authorized to collect aggregated data.
- |
+ / required
+
+ + | +
+ The region authorized to collect aggregated data.
+ |
|
| - | + | ||||
| + |
all_aws_regions
boolean
-
- |
-
-
|
-
- If true, aggregate existing AWS Config regions and future regions.
- |
+
+
+
+
|
+
+ If true, aggregate existing AWS Config regions and future regions.
+ |
| - | + | ||||
| + |
aws_regions
list
- / elements=string
- |
- - | -
- The source regions being aggregated.
- |
+ / elements=string
+
+ + | +
+ The source regions being aggregated.
+ |
| - | + | ||||
| + |
role_arn
string
-
- |
- - | -
- ARN of the IAM role used to retrieve AWS Organization details associated with the aggregator account.
- |
+
+
+ + | +
+ ARN of the IAM role used to retrieve AWS Organization details associated with the aggregator account.
+ |
| + + | |||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
state
string
-
- |
-
-
|
-
- Whether the Config rule should be present or absent.
- |
+
+
+
+
|
+
+ Whether the Config rule should be present or absent.
+ |
|
| + | |||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
|
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
delivery_frequency
string
-
- |
-
-
|
-
- The frequency with which AWS Config delivers configuration snapshots.
- |
+
+
+
+
|
+
+ The frequency with which AWS Config delivers configuration snapshots.
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
name
string
- / required
- |
- - | -
- The name of the AWS Config resource.
- |
+ / required
+
+ + | +
+ The name of the AWS Config resource.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
s3_bucket
string
- / required
- |
- - | -
- The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files.
- |
+ / required
+
+ + | +
+ The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files.
+ |
| + | ||||
|
s3_prefix
string
-
- |
- - | -
- The prefix for the specified Amazon S3 bucket.
- |
+
+
+ + | +
+ The prefix for the specified Amazon S3 bucket.
+ |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
sns_topic_arn
string
-
- |
- - | -
- The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes.
- |
+
+
+ + | +
+ The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes.
+ |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Whether the Config rule should be present or absent.
- |
+
+
+
+
|
+
+ Whether the Config rule should be present or absent.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
name
string
- / required
- |
- - | -
- The name of the AWS Config resource.
- |
+ / required
+
+ + | +
+ The name of the AWS Config resource.
+ |
|
| + | |||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
recording_group
dictionary
-
- |
- - | -
- Specifies the types of AWS resources for which AWS Config records configuration changes.
- Required when state=present
- |
+
+
+ + | +
+ Specifies the types of AWS resources for which AWS Config records configuration changes.
+ Required when state=present
+ |
|
| - | + | ||||
| + |
all_supported
-
-
- |
- - | -
- Specifies whether AWS Config records configuration changes for every supported type of regional resource.
- If all_supported=true, when AWS Config adds support for a new type of regional resource, it starts recording resources of that type automatically.
- If all_supported=true, you cannot enumerate a list of resource_types.
- |
+
+
+ + | +
+ Specifies whether AWS Config records configuration changes for every supported type of regional resource.
+ If all_supported=true, when AWS Config adds support for a new type of regional resource, it starts recording resources of that type automatically.
+ If all_supported=true, you cannot enumerate a list of resource_types.
+ |
| - | + | ||||
| + |
include_global_types
-
-
- |
- - | -
- Specifies whether AWS Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.
- The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources.
- If you set include_global_types=true, you must also set all_supported=true.
- If you set include_global_types=true, when AWS Config adds support for a new type of global resource, it starts recording resources of that type automatically.
- |
+
+
+ + | +
+ Specifies whether AWS Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.
+ The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources.
+ If you set include_global_types=true, you must also set all_supported=true.
+ If you set include_global_types=true, when AWS Config adds support for a new type of global resource, it starts recording resources of that type automatically.
+ |
| - | + | ||||
| + |
resource_types
-
-
- |
- - | -
- A list that specifies the types of AWS resources for which AWS Config records configuration changes (for example,
- AWS::EC2::Instance or AWS::CloudTrail::Trail).Before you can set this option, you must set all_supported=false.
- |
+
+
+ + | +
+ A list that specifies the types of AWS resources for which AWS Config records configuration changes (for example,
+ AWS::EC2::Instance or AWS::CloudTrail::Trail).Before you can set this option, you must set all_supported=false.
+ |
| + + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
role_arn
string
-
- |
- - | -
- Amazon Resource Name (ARN) of the IAM role used to describe the AWS resources associated with the account.
- Required when state=present.
- |
+
+
+ + | +
+ Amazon Resource Name (ARN) of the IAM role used to describe the AWS resources associated with the account.
+ Required when state=present.
+ |
|
| + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
state
string
-
- |
-
-
|
-
- Whether the Config rule should be present or absent.
- |
+
+
+
+
|
+
+ Whether the Config rule should be present or absent.
+ |
|
| + | |||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
|
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
|
| + | |||||
|
description
string
-
- |
- - | -
- The description that you provide for the AWS Config rule.
- |
+
+
+ + | +
+ The description that you provide for the AWS Config rule.
+ |
|
| + | |||||
|
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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
execution_frequency
string
-
- |
-
-
|
-
- The maximum frequency with which AWS Config runs evaluations for a rule.
- |
+
+
+
+
|
+
+ The maximum frequency with which AWS Config runs evaluations for a rule.
+ |
|
| + | |||||
|
input_parameters
string
-
- |
- - | -
- A string, in JSON format, that is passed to the AWS Config rule Lambda function.
- |
+
+
+ + | +
+ A string, in JSON format, that is passed to the AWS Config rule Lambda function.
+ |
|
| + | |||||
|
name
string
- / required
- |
- - | -
- The name of the AWS Config resource.
- |
+ / required
+
+ + | +
+ The name of the AWS Config resource.
+ |
|
| + | |||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
scope
dictionary
-
- |
- - | -
- Defines which resources can trigger an evaluation for the rule.
- |
+
+
+ + | +
+ Defines which resources can trigger an evaluation for the rule.
+ |
|
| - | + | ||||
| + |
compliance_id
-
-
- |
- - | -
- The ID of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for compliance_types.
- |
+
+
+ + | +
+ The ID of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for compliance_types.
+ |
| - | + | ||||
| + |
compliance_types
-
-
- |
- - | -
- The resource types of only those AWS resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for compliance_id.
- |
+
+
+ + | +
+ The resource types of only those AWS resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for compliance_id.
+ |
| - | + | ||||
| + |
tag_key
-
-
- |
- - | -
- The tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule.
- |
+
+
+ + | +
+ The tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule.
+ |
| - | + | ||||
| + |
tag_value
-
-
- |
- - | -
- The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule. If you specify a value for tag_value, you must also specify a value for tag_key.
- |
+
+
+ + | +
+ The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule. If you specify a value for tag_value, you must also specify a value for tag_key.
+ |
| + + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
source
dictionary
- / required
- |
- - | -
- Provides the rule owner (AWS or customer), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.
- |
+ / required
+
+ + | +
+ Provides the rule owner (AWS or customer), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.
+ |
|
| - | + | ||||
| + |
details
-
-
- |
- - | -
- Provides the source and type of the event that causes AWS Config to evaluate your AWS resources.
- This parameter expects a list of dictionaries. Each dictionary expects the following key/value pairs.
- Key `EventSource` The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources.
- Key `MessageType` The type of notification that triggers AWS Config to run an evaluation for a rule.
- Key `MaximumExecutionFrequency` The frequency at which you want AWS Config to run evaluations for a custom rule with a periodic trigger.
- |
+
+
+ + | +
+ Provides the source and type of the event that causes AWS Config to evaluate your AWS resources.
+ This parameter expects a list of dictionaries. Each dictionary expects the following key/value pairs.
+ Key `EventSource` The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources.
+ Key `MessageType` The type of notification that triggers AWS Config to run an evaluation for a rule.
+ Key `MaximumExecutionFrequency` The frequency at which you want AWS Config to run evaluations for a custom rule with a periodic trigger.
+ |
| - | + | ||||
| + |
identifier
-
-
- |
- - | -
- The ID of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for compliance_types.
- |
+
+
+ + | +
+ The ID of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for compliance_types.
+ |
| - | + | ||||
| + |
owner
-
-
- |
- - | -
- The resource types of only those AWS resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for compliance_id.
- |
+
+
+ + | +
+ The resource types of only those AWS resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for compliance_id.
+ |
| + + | |||||
|
state
string
-
- |
-
-
|
-
- Whether the Config rule should be present or absent.
- |
+
+
+
+
|
+
+ Whether the Config rule should be present or absent.
+ |
|
| + | |||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
|
| Parameter | +Choices/Defaults | +Comments | +
|---|---|---|
|
+
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
+ aliases: ec2_secret_key, secret_key |
+
|
+
+ connection_id
+
+
+ string
+
+ |
+ + | +
+ The ID of the Direct Connect connection.
+ One of connection_id or name must be specified.
+ |
+
|
+
+ 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 |
+
|
+
+ name
+
+
+ string
+
+ |
+ + | +
+ The name of the Direct Connect connection.
+ One of connection_id or name must be specified.
+ |
+
|
+
+ profile
+
+
+ string
+
+ |
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
+
|
+
+ 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 |
+
|
+
+ 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.
+ aliases: aws_security_token, access_token |
+
|
+
+ validate_certs
+
+
+ boolean
+
+ |
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
+
| Key | +Returned | +Description | +
|---|---|---|
|
+
+ connection_state
+
+
+ string
+
+ |
+ always | +
+ The state of the connection.
+ + Sample:
+ pending
+ |
+
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
bandwidth
string
-
- |
-
-
|
-
- The bandwidth of the Direct Connect connection.
- Required when state=present.
- |
+
+
+
+
|
+
+ The bandwidth of the Direct Connect connection.
+ Required when state=present.
+ |
| + | ||||
|
connection_id
string
-
- |
- - | -
- The ID of the Direct Connect connection.
- Modifying attributes of a connection with forced_update will result in a new Direct Connect connection ID.
- One of connection_id or name must be specified.
- |
+
+
+ + | +
+ The ID of the Direct Connect connection.
+ Modifying attributes of a connection with forced_update will result in a new Direct Connect connection ID.
+ One of connection_id or name must be specified.
+ |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
forced_update
boolean
-
- |
-
-
|
-
- To modify bandwidth or location the connection will need to be deleted and recreated. By default this will not happen - this option must be set to True.
- |
+
+
+
+
|
+
+ To modify bandwidth or location the connection will need to be deleted and recreated. By default this will not happen - this option must be set to True.
+ |
| + | ||||
|
link_aggregation_group
string
-
- |
- - | -
- The ID of the link aggregation group you want to associate with the connection.
- This is optional when a stand-alone connection is desired.
- |
+
+
+ + | +
+ The ID of the link aggregation group you want to associate with the connection.
+ This is optional when a stand-alone connection is desired.
+ |
| + | ||||
|
location
string
-
- |
- - | -
- Where the Direct Connect connection is located.
- Required when state=present.
- |
+
+
+ + | +
+ Where the Direct Connect connection is located.
+ Required when state=present.
+ |
| + | ||||
|
name
string
-
- |
- - | -
- The name of the Direct Connect connection. This is required to create a new connection.
- One of connection_id or name must be specified.
- |
+
+
+ + | +
+ The name of the Direct Connect connection. This is required to create a new connection.
+ One of connection_id or name must be specified.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
- / required
- |
-
-
|
-
- The state of the Direct Connect connection.
- |
+ / required
+
+
+
|
+
+ The state of the Direct Connect connection.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
amazon_asn
string
-
- |
- - | -
- The Amazon side ASN.
- Required when state=present.
- |
+
+
+ + | +
+ The Amazon side ASN.
+ Required when state=present.
+ |
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
direct_connect_gateway_id
string
-
- |
- - | -
- The ID of an existing Direct Connect Gateway.
- Required when state=absent.
- |
+
+
+ + | +
+ The ID of an existing Direct Connect Gateway.
+ Required when state=absent.
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
name
string
-
- |
- - | -
- Name of the Direct Connect Gateway to be created or deleted.
- |
+
+
+ + | +
+ Name of the Direct Connect Gateway to be created or deleted.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Set state=present to ensure a resource is created.
- Set state=absent to remove a resource.
- |
+
+
+
+
|
+
+ Set state=present to ensure a resource is created.
+ Set state=absent to remove a resource.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
virtual_gateway_id
string
-
- |
- - | -
- The VPN gateway ID of an existing virtual gateway.
- |
+
+
+ + | +
+ The VPN gateway ID of an existing virtual gateway.
+ |
| + | ||||
|
wait_timeout
integer
-
- |
-
- Default: 320
- |
-
- How long to wait for the association to be deleted.
- |
+
+
+
+ Default: 320
+ |
+
+ How long to wait for the association to be deleted.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments |
|---|---|---|---|
| + | |||
|
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.
- aliases: ec2_access_key, access_key |
- |
| + + | ++ | +
+ 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.
+ aliases: ec2_access_key, access_key |
+ |
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
- |
| + + | ++ | +
+ 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.
- aliases: ec2_secret_key, secret_key |
- |
| + + | ++ | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
+ |
|
bandwidth
string
-
- |
- - | -
- The bandwidth of the link aggregation group.
- |
- |
| + + | ++ | +
+ The bandwidth of the link aggregation group.
+ |
+ |
|
connection_id
string
-
- |
- - | -
- A connection ID to link with the link aggregation group upon creation.
- |
- |
| + + | ++ | +
+ A connection ID to link with the link aggregation group upon creation.
+ |
+ |
|
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.
- |
- |
| + + | +
+
|
+
+ 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.
+ |
+ |
|
delete_with_disassociation
boolean
-
- |
-
-
|
-
- To be used with state=absent to delete connections after disassociating them with the LAG.
- |
- |
| + + | +
+
|
+
+ To be used with state=absent to delete connections after disassociating them with the LAG.
+ |
+ |
|
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.
- |
- |
| + + | ++ | +
+ 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 |
+ |
|
force_delete
boolean
-
- |
-
-
|
-
- This allows the minimum number of links to be set to 0, any hosted connections disassociated, and any virtual interfaces associated to the LAG deleted.
- |
- |
| + + | +
+
|
+
+ This allows the minimum number of links to be set to 0, any hosted connections disassociated, and any virtual interfaces associated to the LAG deleted.
+ |
+ |
|
link_aggregation_group_id
string
-
- |
- - | -
- The ID of the Direct Connect link aggregation group.
- |
- |
| + + | ++ | +
+ The ID of the Direct Connect link aggregation group.
+ |
+ |
|
location
string
-
- |
- - | -
- The location of the link aggregation group.
- |
- |
| + + | ++ | +
+ The location of the link aggregation group.
+ |
+ |
|
min_links
integer
-
- |
- - | -
- The minimum number of physical connections that must be operational for the LAG itself to be operational.
- |
- |
| + + | ++ | +
+ The minimum number of physical connections that must be operational for the LAG itself to be operational.
+ |
+ |
|
name
string
-
- |
- - | -
- The name of the Direct Connect link aggregation group.
- |
- |
| + + | ++ | +
+ The name of the Direct Connect link aggregation group.
+ |
+ |
|
num_connections
integer
-
- |
- - | -
- The number of connections with which to initialize the link aggregation group.
- |
- |
| + + | ++ | +
+ The number of connections with which to initialize the link aggregation group.
+ |
+ |
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
- |
| + + | ++ | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
+ |
|
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 |
- |
| + + | ++ | +
+ 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 |
+ |
|
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.
- aliases: access_token |
- |
| + + | ++ | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
+ |
|
state
string
- / required
- |
-
-
|
-
- The state of the Direct Connect link aggregation group.
- |
- |
| + / required + | +
+
|
+
+ The state of the Direct Connect link aggregation group.
+ |
+ |
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
- |
| + + | +
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
+ |
|
wait
boolean
-
- |
-
-
|
-
- Whether or not to wait for the operation to complete.
- May be useful when waiting for virtual interfaces to be deleted.
- The time to wait can be controlled by setting wait_timeout.
- |
- |
| + + | +
+
|
+
+ Whether or not to wait for the operation to complete.
+ May be useful when waiting for virtual interfaces to be deleted.
+ The time to wait can be controlled by setting wait_timeout.
+ |
+ |
|
wait_timeout
integer
-
- |
-
- Default: 120
- |
-
- The duration in seconds to wait if wait=true.
- |
-
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
address_type
string
-
- |
- - | -
- The type of IP address for the BGP peer.
- |
+
+
+ + | +
+ The type of IP address for the BGP peer.
+ |
| + | ||||
|
amazon_address
string
-
- |
- - | -
- The amazon address CIDR with which to create the virtual interface.
- |
+
+
+ + | +
+ The amazon address CIDR with which to create the virtual interface.
+ |
| + | ||||
|
authentication_key
string
-
- |
- - | -
- The authentication key for BGP configuration.
- |
+
+
+ + | +
+ The authentication key for BGP configuration.
+ |
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
bgp_asn
integer
-
- |
-
- Default: 65000
- |
-
- The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
- |
+
+
+
+ Default: 65000
+ |
+
+ The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
+ |
| + | ||||
|
cidr
list
- / elements=string
- |
- - | -
- A list of route filter prefix CIDRs with which to create the public virtual interface.
- |
+ / elements=string
+
+ + | +
+ A list of route filter prefix CIDRs with which to create the public virtual interface.
+ |
| + | ||||
|
customer_address
string
-
- |
- - | -
- The customer address CIDR with which to create the virtual interface.
- |
+
+
+ + | +
+ The customer address CIDR with which to create the virtual interface.
+ |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
+
+ direct_connect_gateway_id
+
+
+ string
+
+ |
+ + | +
+ The direct connect gateway ID for creating a private virtual interface.
+ To create a private virtual interface virtual_gateway_id or direct_connect_gateway_id is required. These options are mutually exclusive.
+ |
+ ||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
id_to_associate
string
- / required
- |
- - | -
- The ID of the link aggregation group or connection to associate with the virtual interface.
- aliases: link_aggregation_group_id, connection_id |
+ / required
+
+ + | +
+ The ID of the link aggregation group or connection to associate with the virtual interface.
+ aliases: link_aggregation_group_id, connection_id |
| + | ||||
|
name
string
-
- |
- - | -
- The name of the virtual interface.
- |
+
+
+ + | +
+ The name of the virtual interface.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
public
boolean
-
- |
-
-
|
-
- The type of virtual interface.
- |
+
+
+
+
|
+
+ The type of virtual interface.
+ |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
- / required
- |
-
-
|
-
- The desired state of the Direct Connect virtual interface.
- |
+ / required
+
+
+
|
+
+ The desired state of the Direct Connect virtual interface.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
virtual_gateway_id
string
-
- |
- - | -
- The virtual gateway ID required for creating a private virtual interface.
- |
+
+
+ + | +
+ The virtual gateway ID required for creating a private virtual interface.
+ To create a private virtual interface virtual_gateway_id or direct_connect_gateway_id is required. These options are mutually exclusive.
+ |
| + | ||||
|
virtual_interface_id
string
-
- |
- - | -
- The virtual interface ID.
- |
+
+
+ + | +
+ The virtual interface ID.
+ |
| + | ||||
|
vlan
integer
-
- |
-
- Default: 100
- |
-
- The VLAN ID.
- |
-
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
name
string
- / required
- |
- - | -
- Name of EKS cluster
- |
+ / required
+
+ + | +
+ Name of EKS cluster
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
role_arn
string
-
- |
- - | -
- ARN of IAM role used by the EKS cluster
- |
+
+
+ + | +
+ ARN of IAM role used by the EKS cluster
+ |
| + | ||||
|
security_groups
list
- / elements=string
- |
- - | -
- list of security group names or IDs
- |
+ / elements=string
+
+ + | +
+ list of security group names or IDs
+ |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- desired state of the EKS cluster
- |
+
+
+
+
|
+
+ desired state of the EKS cluster
+ |
| + | ||||
|
subnets
list
- / elements=string
- |
- - | -
- list of subnet IDs for the Kubernetes cluster
- |
+ / elements=string
+
+ + | +
+ list of subnet IDs for the Kubernetes cluster
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
version
string
-
- |
- - | -
- Kubernetes version - defaults to latest
- |
+
+
+ + | +
+ Kubernetes version - defaults to latest
+ |
| + | ||||
|
wait
boolean
-
- |
-
-
|
-
- Specifies whether the module waits until the cluster is active or deleted before moving on. It takes "usually less than 10 minutes" per AWS documentation.
- |
+
+
+
+
|
+
+ Specifies whether the module waits until the cluster is active or deleted before moving on. It takes "usually less than 10 minutes" per AWS documentation.
+ |
| + | ||||
|
wait_timeout
integer
-
- |
-
- Default: 1200
- |
-
- The duration in seconds to wait for the cluster to become active. Defaults to 1200 seconds (20 minutes).
- |
+
+
+
+ Default: 1200
+ |
+
+ The duration in seconds to wait for the cluster to become active. Defaults to 1200 seconds (20 minutes).
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
app_name
string
-
- |
- - | -
- Name of the beanstalk application you wish to manage.
- aliases: name |
+
+
+ + | +
+ Name of the beanstalk application you wish to manage.
+ aliases: name |
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
description
string
-
- |
- - | -
- The description of the application.
- |
+
+
+ + | +
+ The description of the application.
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Whether to ensure the application is present or absent.
- |
+
+
+
+
|
+
+ Whether to ensure the application is present or absent.
+ |
| + | ||||
|
terminate_by_force
boolean
-
- |
-
-
|
-
- When terminate_by_force=true, running environments will be terminated before deleting the application.
- |
+
+
+
+
|
+
+ When terminate_by_force=true, running environments will be terminated before deleting the application.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
catalog_id
string
-
- |
- - | -
- The ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default.
- |
+
+
+ + | +
+ The ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default.
+ |
| + | ||||
|
connection_properties
dictionary
-
- |
- - | -
- A dict of key-value pairs used as parameters for this connection.
- Required when state=present.
- |
+
+
+ + | +
+ A dict of key-value pairs used as parameters for this connection.
+ Required when state=present.
+ |
| + | ||||
|
connection_type
string
-
- |
-
-
|
-
- The type of the connection. Currently, only JDBC is supported; SFTP is not supported.
- |
+
+
+
+
|
+
+ The type of the connection. Currently, only JDBC is supported; SFTP is not supported.
+ |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
description
string
-
- |
- - | -
- The description of the connection.
- |
+
+
+ + | +
+ The description of the connection.
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
match_criteria
list
- / elements=string
- |
- - | -
- A list of UTF-8 strings that specify the criteria that you can use in selecting this connection.
- |
+ / elements=string
+
+ + | +
+ A list of UTF-8 strings that specify the criteria that you can use in selecting this connection.
+ |
| + | ||||
|
name
string
- / required
- |
- - | -
- The name of the connection.
- |
+ / required
+
+ + | +
+ The name of the connection.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
security_groups
list
- / elements=string
- |
- - | -
- A list of security groups to be used by the connection. Use either security group name or ID.
- |
+ / elements=string
+
+ + | +
+ A list of security groups to be used by the connection. Use either security group name or ID.
+ |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
- / required
- |
-
-
|
-
- Create or delete the AWS Glue connection.
- |
+ / required
+
+
+
|
+
+ Create or delete the AWS Glue connection.
+ |
| + | ||||
|
subnet_id
string
-
- |
- - | -
- The subnet ID used by the connection.
- |
+
+
+ + | +
+ The subnet ID used by the connection.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
allocated_capacity
integer
-
- |
- - | -
- The number of AWS Glue data processing units (DPUs) to allocate to this Job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.
- |
+
+
+ + | +
+ The number of AWS Glue data processing units (DPUs) to allocate to this Job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.
+ |
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
command_name
string
-
- |
-
- Default: "glueetl"
- |
-
- The name of the job command. This must be 'glueetl'.
- |
+
+
+
+ Default: "glueetl"
+ |
+
+ The name of the job command. This must be 'glueetl'.
+ |
| + | ||||
|
command_script_location
string
-
- |
- - | -
- The S3 path to a script that executes a job.
- Required when state=present.
- |
+
+
+ + | +
+ The S3 path to a script that executes a job.
+ Required when state=present.
+ |
| + | ||||
|
connections
list
- / elements=string
- |
- - | -
- A list of Glue connections used for this job.
- |
+ / elements=string
+
+ + | +
+ A list of Glue connections used for this job.
+ |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
default_arguments
dictionary
-
- |
- - | -
- A dict of default arguments for this job. You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.
- |
+
+
+ + | +
+ A dict of default arguments for this job. You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.
+ |
| + | ||||
|
description
string
-
- |
- - | -
- Description of the job being defined.
- |
+
+
+ + | +
+ Description of the job being defined.
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
max_concurrent_runs
integer
-
- |
- - | -
- The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.
- |
+
+
+ + | +
+ The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.
+ |
| + | ||||
|
max_retries
integer
-
- |
- - | -
- The maximum number of times to retry this job if it fails.
- |
+
+
+ + | +
+ The maximum number of times to retry this job if it fails.
+ |
| + | ||||
|
name
string
- / required
- |
- - | -
- The name you assign to this job definition. It must be unique in your account.
- |
+ / required
+
+ + | +
+ The name you assign to this job definition. It must be unique in your account.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
role
string
-
- |
- - | -
- The name or ARN of the IAM role associated with this job.
- Required when state=present.
- |
+
+
+ + | +
+ The name or ARN of the IAM role associated with this job.
+ Required when state=present.
+ |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
- / required
- |
-
-
|
-
- Create or delete the AWS Glue job.
- |
+ / required
+
+
+
|
+
+ Create or delete the AWS Glue job.
+ |
| + | ||||
|
timeout
integer
-
- |
- - | -
- The job timeout in minutes.
- |
+
+
+ + | +
+ The job timeout in minutes.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
-
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
name
string
- / required
- |
- - | -
- The user-defined name that identifies the assessment target. The name must be unique within the AWS account.
- |
+ / required
+
+ + | +
+ The user-defined name that identifies the assessment target. The name must be unique within the AWS account.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- The state of the assessment target.
- |
+
+
+
+
|
+
+ The state of the assessment target.
+ |
| + | ||||
|
tags
dictionary
-
- |
- - | -
- Tags of the EC2 instances to be added to the assessment target.
- Required if
- state=present. |
+
+
+ + | +
+ Tags of the EC2 instances to be added to the assessment target.
+ Required if
+ state=present. |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
filters
dictionary
-
- |
- - | -
- A dict of filters to apply. Each dict item consists of a filter key and a filter value. The filters aren't natively supported by boto3, but are supported to provide similar functionality to other modules. Standard tag filters (
- tag-key, tag-value and tag:tagName) are available, as are key-id and alias |
+
+
+ + | +
+ A dict of filters to apply. Each dict item consists of a filter key and a filter value. The filters aren't natively supported by boto3, but are supported to provide similar functionality to other modules. Standard tag filters (
+ tag-key, tag-value and tag:tagName) are available, as are key-id and alias |
| + | ||||
|
pending_deletion
boolean
-
- |
-
-
|
-
- Whether to get full details (tags, grants etc.) of keys pending deletion
- |
+
+
+
+
|
+
+ Whether to get full details (tags, grants etc.) of keys pending deletion
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
-
KeyState is true.KeyState is true.AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported or the CMK lacks key material.AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported or the CMK lacks key material.| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
alias
string
-
- |
- - | -
- An alias for a key. For safety, even though KMS does not require keys to have an alias, this module expects all new keys to be given an alias to make them easier to manage. Existing keys without an alias may be referred to by key_id. Use community.aws.aws_kms_info to find key ids. Required if key_id is not given. Note that passing a key_id and alias will only cause a new alias to be added, an alias will never be renamed. The 'alias/' prefix is optional.
- aliases: key_alias |
+
+
+ + | +
+ An alias for a key. For safety, even though KMS does not require keys to have an alias, this module expects all new keys to be given an alias to make them easier to manage. Existing keys without an alias may be referred to by key_id. Use community.aws.aws_kms_info to find key ids. Required if key_id is not given. Note that passing a key_id and alias will only cause a new alias to be added, an alias will never be renamed. The 'alias/' prefix is optional.
+ aliases: key_alias |
|
| + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
|
| + | |||||
|
description
string
-
- |
- - | -
- A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task.
- |
+
+
+ + | +
+ A description of the CMK. Use a description that helps you decide whether the CMK is appropriate for a task.
+ |
|
| + | |||||
|
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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
enable_key_rotation
boolean
-
- |
-
-
|
-
- Whether the key should be automatically rotated every year.
- |
+
+
+
+
|
+
+ Whether the key should be automatically rotated every year.
+ |
|
| + | |||||
|
enabled
boolean
-
- |
-
-
|
-
- Whether or not a key is enabled
- |
+
+
+
+
|
+
+ Whether or not a key is enabled
+ |
|
| + | |||||
|
grants
list
- / elements=dictionary
- |
- - | -
- A list of grants to apply to the key. Each item must contain grantee_principal. Each item can optionally contain retiring_principal, operations, constraints, name.
- grantee_principal and retiring_principal must be ARNs
- For full documentation of suboptions see the boto3 documentation:
-
- |
+ / elements=dictionary
+
+ + | +
+ A list of grants to apply to the key. Each item must contain grantee_principal. Each item can optionally contain retiring_principal, operations, constraints, name.
+ grantee_principal and retiring_principal must be ARNs
+ For full documentation of suboptions see the boto3 documentation:
+
+ |
|
| - | + | ||||
| + |
constraints
dictionary
-
- |
- - | -
- Constraints is a dict containing
- encryption_context_subset or encryption_context_equals, either or both being a dict specifying an encryption context match. See https://docs.aws.amazon.com/kms/latest/APIReference/API_GrantConstraints.html or https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kms.html#KMS.Client.create_grant |
+
+
+ + | +
+ Constraints is a dict containing
+ encryption_context_subset or encryption_context_equals, either or both being a dict specifying an encryption context match. See https://docs.aws.amazon.com/kms/latest/APIReference/API_GrantConstraints.html or https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kms.html#KMS.Client.create_grant |
| - | + | ||||
| + |
grantee_principal
string
- / required
- |
- - | -
- The full ARN of the principal being granted permissions.
- |
+ / required
+
+ + | +
+ The full ARN of the principal being granted permissions.
+ |
| - | + | ||||
| + |
operations
list
- / elements=string
- |
-
-
|
-
- A list of operations that the grantee may perform using the CMK.
- |
+ / elements=string
+
+
+
|
+
+ A list of operations that the grantee may perform using the CMK.
+ |
| - | + | ||||
| + |
retiring_principal
string
-
- |
- - | -
- The full ARN of the principal permitted to revoke/retire the grant.
- |
+
+
+ + | +
+ The full ARN of the principal permitted to revoke/retire the grant.
+ |
| + + | |||||
|
key_id
string
-
- |
- - | -
- Key ID or ARN of the key.
- One of alias or key_id are required.
- aliases: key_arn |
+
+
+ + | +
+ Key ID or ARN of the key.
+ One of alias or key_id are required.
+ aliases: key_arn |
|
| + | |||||
|
policy
json
-
- |
- - | -
- policy to apply to the KMS key.
-
- |
+
+
+ + | +
+ policy to apply to the KMS key.
+
+ |
|
| + | |||||
|
policy_clean_invalid_entries
boolean
-
- |
-
-
|
-
- (deprecated) If adding/removing a role and invalid grantees are found, remove them. These entries will cause an update to fail in all known cases.
- Only cleans if changes are being made.
- Used for modifying the Key Policy rather than modifying a grant and only works on the default policy created through the AWS Console.
- This option has been deprecated, and will be removed in 2.13. Use policy instead.
- aliases: clean_invalid_entries |
+
+
+
+
|
+
+ (deprecated) If adding/removing a role and invalid grantees are found, remove them. These entries will cause an update to fail in all known cases.
+ Only cleans if changes are being made.
+ Used for modifying the Key Policy rather than modifying a grant and only works on the default policy created through the AWS Console.
+ This option has been deprecated, and will be removed in 2.13. Use policy instead.
+ aliases: clean_invalid_entries |
|
| + | |||||
|
policy_grant_types
list
- / elements=string
- |
- - | -
- (deprecated) List of grants to give to user/role. Likely "role,role grant" or "role,role grant,admin".
- Required when policy_mode=grant.
- Used for modifying the Key Policy rather than modifying a grant and only works on the default policy created through the AWS Console.
- This option has been deprecated, and will be removed in 2.13. Use policy instead.
- aliases: grant_types |
+ / elements=string
+
+ + | +
+ (deprecated) List of grants to give to user/role. Likely "role,role grant" or "role,role grant,admin".
+ Required when policy_mode=grant.
+ Used for modifying the Key Policy rather than modifying a grant and only works on the default policy created through the AWS Console.
+ This option has been deprecated, and will be removed in 2.13. Use policy instead.
+ aliases: grant_types |
|
| + | |||||
|
policy_mode
string
-
- |
-
-
|
-
- (deprecated) Grant or deny access.
- Used for modifying the Key Policy rather than modifying a grant and only works on the default policy created through the AWS Console.
- This option has been deprecated, and will be removed in 2.13. Use policy instead.
- aliases: mode |
+
+
+
+
|
+
+ (deprecated) Grant or deny access.
+ Used for modifying the Key Policy rather than modifying a grant and only works on the default policy created through the AWS Console.
+ This option has been deprecated, and will be removed in 2.13. Use policy instead.
+ aliases: mode |
|
| + | |||||
|
policy_role_arn
string
-
- |
- - | -
- (deprecated) ARN of role to allow/deny access.
- One of policy_role_name or policy_role_arn are required.
- Used for modifying the Key Policy rather than modifying a grant and only works on the default policy created through the AWS Console.
- This option has been deprecated, and will be removed in 2.13. Use policy instead.
- aliases: role_arn |
+
+
+ + | +
+ (deprecated) ARN of role to allow/deny access.
+ One of policy_role_name or policy_role_arn are required.
+ Used for modifying the Key Policy rather than modifying a grant and only works on the default policy created through the AWS Console.
+ This option has been deprecated, and will be removed in 2.13. Use policy instead.
+ aliases: role_arn |
|
| + | |||||
|
policy_role_name
string
-
- |
- - | -
- (deprecated) Role to allow/deny access.
- One of policy_role_name or policy_role_arn are required.
- Used for modifying the Key Policy rather than modifying a grant and only works on the default policy created through the AWS Console.
- This option has been deprecated, and will be removed in 2.13. Use policy instead.
- aliases: role_name |
+
+
+ + | +
+ (deprecated) Role to allow/deny access.
+ One of policy_role_name or policy_role_arn are required.
+ Used for modifying the Key Policy rather than modifying a grant and only works on the default policy created through the AWS Console.
+ This option has been deprecated, and will be removed in 2.13. Use policy instead.
+ aliases: role_name |
|
| + | |||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
purge_grants
boolean
-
- |
-
-
|
-
- Whether the grants argument should cause grants not in the list to be removed
- |
+
+
+
+
|
+
+ Whether the grants argument should cause grants not in the list to be removed
+ |
|
| + | |||||
|
purge_tags
boolean
-
- |
-
-
|
-
- Whether the tags argument should cause tags not in the list to be removed
- |
+
+
+
+
|
+
+ Whether the tags argument should cause tags not in the list to be removed
+ |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
state
string
-
- |
-
-
|
-
- Whether a key should be present or absent. Note that making an existing key absent only schedules a key for deletion. Passing a key that is scheduled for deletion with state present will cancel key deletion.
- |
+
+
+
+
|
+
+ Whether a key should be present or absent. Note that making an existing key absent only schedules a key for deletion. Passing a key that is scheduled for deletion with state present will cancel key deletion.
+ |
|
| + | |||||
|
tags
dictionary
-
- |
- - | -
- A dictionary of tags to apply to a key.
- |
+
+
+ + | +
+ A dictionary of tags to apply to a key.
+ |
|
| + | |||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
|
KeyState is true.KeyState is true.AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported or the CMK lacks key material.AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported or the CMK lacks key material.| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
filters
dictionary
-
- |
-
- Default: {}
- |
-
- A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeRegions.html for possible filters. Filter names and values are case sensitive. You can also use underscores instead of dashes (-) in the filter keys, which will take precedence in case of conflict.
- |
+
+
+
+ Default: {}
+ |
+
+ A dict of filters to apply.
+ Each dict item consists of a filter key and a filter value.
+ See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeRegions.html for possible filters.
+ Filter names and values are case sensitive.
+ You can use underscores instead of dashes (-) in the filter keys.
+ Filter keys with underscores will take precedence in case of conflict.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
name
string
- / required
- |
- - | -
- Name of the s3 bucket
- |
+ / required
+
+ + | +
+ Name of the s3 bucket
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
rules
list
-
- |
- - | -
- Cors rules to put on the s3 bucket
- |
+ / elements=string
+
+ + | +
+ Cors rules to put on the s3 bucket
+ |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
- / required
- |
-
-
|
-
- Create or remove cors on the s3 bucket
- |
+ / required
+
+
+
|
+
+ Create or remove cors on the s3 bucket
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
description
string
-
- |
- - | -
- Specifies a user-provided description of the secret.
- |
+
+
+ + | +
+ Specifies a user-provided description of the secret.
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
kms_key_id
string
-
- |
- - | -
- Specifies the ARN or alias of the AWS KMS customer master key (CMK) to be used to encrypt the `secret_string` or `secret_binary` values in the versions stored in this secret.
- |
+
+
+ + | +
+ Specifies the ARN or alias of the AWS KMS customer master key (CMK) to be used to encrypt the `secret_string` or `secret_binary` values in the versions stored in this secret.
+ |
| + | ||||
|
name
string
- / required
- |
- - | -
- Friendly name for the secret you are creating.
- |
+ / required
+
+ + | +
+ Friendly name for the secret you are creating.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
recovery_window
integer
-
- |
-
- Default: 30
- |
-
- Only used if state is absent.
- Specifies the number of days that Secrets Manager waits before it can delete the secret.
- If set to 0, the deletion is forced without recovery.
- |
+
+
+
+ Default: 30
+ |
+
+ Only used if state is absent.
+ Specifies the number of days that Secrets Manager waits before it can delete the secret.
+ If set to 0, the deletion is forced without recovery.
+ |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
rotation_interval
integer
-
- |
-
- Default: 30
- |
-
- Specifies the number of days between automatic scheduled rotations of the secret.
- |
+
+
+
+ Default: 30
+ |
+
+ Specifies the number of days between automatic scheduled rotations of the secret.
+ |
| + | ||||
|
rotation_lambda
string
-
- |
- - | -
- Specifies the ARN of the Lambda function that can rotate the secret.
- |
+
+
+ + | +
+ Specifies the ARN of the Lambda function that can rotate the secret.
+ |
| + | ||||
|
secret
string
-
- |
-
- Default: ""
- |
-
- Specifies string or binary data that you want to encrypt and store in the new version of the secret.
- |
+
+
+
+ Default: ""
+ |
+
+ Specifies string or binary data that you want to encrypt and store in the new version of the secret.
+ |
| + | ||||
|
secret_type
string
-
- |
-
-
|
-
- Specifies the type of data that you want to encrypt.
- |
+
+
+
+
|
+
+ Specifies the type of data that you want to encrypt.
+ |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Whether the secret should be exist or not.
- |
+
+
+
+
|
+
+ Whether the secret should be exist or not.
+ |
| + | ||||
|
tags
dictionary
-
- |
- - | -
- Specifies a list of user-defined tags that are attached to the secret.
- |
+
+
+ + | +
+ Specifies a list of user-defined tags that are attached to the secret.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
bounce_notifications
dictionary
-
- |
- - | -
- Setup the SNS topic used to report bounce notifications.
- If omitted, bounce notifications will not be delivered to a SNS topic.
- If bounce notifications are not delivered to a SNS topic, feedback_forwarding must be enabled.
- |
- |||
| - | + + | ++ | +
+ Setup the SNS topic used to report bounce notifications.
+ If omitted, bounce notifications will not be delivered to a SNS topic.
+ If bounce notifications are not delivered to a SNS topic, feedback_forwarding must be enabled.
+ |
+ ||
| + |
include_headers
boolean
-
- |
-
-
|
-
- Whether or not to include headers when delivering to the SNS topic.
- If topic is not specified this will have no impact, but the SES setting is updated even if there is no topic.
- |
+
+
+
+
|
+
+ Whether or not to include headers when delivering to the SNS topic.
+ If topic is not specified this will have no impact, but the SES setting is updated even if there is no topic.
+ |
| - | + | ||||
| + |
topic
-
-
- |
- - | -
- The ARN of the topic to send notifications to.
- If omitted, notifications will not be delivered to a SNS topic.
- |
- ||
| + + | ++ | +
+ The ARN of the topic to send notifications to.
+ If omitted, notifications will not be delivered to a SNS topic.
+ |
+ |||
|
complaint_notifications
dictionary
-
- |
- - | -
- Setup the SNS topic used to report complaint notifications.
- If omitted, complaint notifications will not be delivered to a SNS topic.
- If complaint notifications are not delivered to a SNS topic, feedback_forwarding must be enabled.
- |
- |||
| - | + + | ++ | +
+ Setup the SNS topic used to report complaint notifications.
+ If omitted, complaint notifications will not be delivered to a SNS topic.
+ If complaint notifications are not delivered to a SNS topic, feedback_forwarding must be enabled.
+ |
+ ||
| + |
include_headers
boolean
-
- |
-
-
|
-
- Whether or not to include headers when delivering to the SNS topic.
- If topic is not specified this will have no impact, but the SES setting is updated even if there is no topic.
- |
+
+
+
+
|
+
+ Whether or not to include headers when delivering to the SNS topic.
+ If topic is not specified this will have no impact, but the SES setting is updated even if there is no topic.
+ |
| - | + | ||||
| + |
topic
-
-
- |
- - | -
- The ARN of the topic to send notifications to.
- If omitted, notifications will not be delivered to a SNS topic.
- |
- ||
| + + | ++ | +
+ The ARN of the topic to send notifications to.
+ If omitted, notifications will not be delivered to a SNS topic.
+ |
+ |||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
|
| + | |||||
|
delivery_notifications
dictionary
-
- |
- - | -
- Setup the SNS topic used to report delivery notifications.
- If omitted, delivery notifications will not be delivered to a SNS topic.
- |
- |||
| - | + + | ++ | +
+ Setup the SNS topic used to report delivery notifications.
+ If omitted, delivery notifications will not be delivered to a SNS topic.
+ |
+ ||
| + |
include_headers
boolean
-
- |
-
-
|
-
- Whether or not to include headers when delivering to the SNS topic.
- If topic is not specified this will have no impact, but the SES setting is updated even if there is no topic.
- |
+
+
+
+
|
+
+ Whether or not to include headers when delivering to the SNS topic.
+ If topic is not specified this will have no impact, but the SES setting is updated even if there is no topic.
+ |
| - | + | ||||
| + |
topic
-
-
- |
- - | -
- The ARN of the topic to send notifications to.
- If omitted, notifications will not be delivered to a SNS topic.
- |
- ||
| + + | ++ | +
+ The ARN of the topic to send notifications to.
+ If omitted, notifications will not be delivered to a SNS topic.
+ |
+ |||
|
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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
feedback_forwarding
boolean
-
- |
-
-
|
-
- Whether or not to enable feedback forwarding.
- This can only be false if both bounce_notifications and complaint_notifications specify SNS topics.
- |
+
+
+
+
|
+
+ Whether or not to enable feedback forwarding.
+ This can only be false if both bounce_notifications and complaint_notifications specify SNS topics.
+ |
|
| + | |||||
|
identity
string
- / required
- |
- - | -
- This is the email address or domain to verify / delete.
- If this contains an '@' then it will be considered an email. Otherwise it will be considered a domain.
- |
+ / required
+
+ + | +
+ This is the email address or domain to verify / delete.
+ If this contains an '@' then it will be considered an email. Otherwise it will be considered a domain.
+ |
|
| + | |||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
state
string
-
- |
-
-
|
-
- Whether to create(or update) or delete the identity.
- |
+
+
+
+
|
+
+ Whether to create(or update) or delete the identity.
+ |
|
| + | |||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
- |||
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
identity
string
- / required
- |
- - | -
- The SES identity to attach or remove a policy from. This can be either the full ARN or just
+ / required
+ |
+ + | +
+ The SES identity to attach or remove a policy from. This can be either the full ARN or just
the verified email or domain.
- |
+
| + | ||||
|
policy
json
-
- |
- - | -
- A properly formatted JSON sending authorization policy. Required when state=present.
- |
+
+
+ + | +
+ A properly formatted JSON sending authorization policy. Required when state=present.
+ |
| + | ||||
|
policy_name
string
- / required
- |
- - | -
- The name used to identify the policy within the scope of the identity it's attached to.
- |
+ / required
+
+ + | +
+ The name used to identify the policy within the scope of the identity it's attached to.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Whether to create(or update) or delete the authorization policy on the identity.
- |
+
+
+
+
|
+
+ Whether to create(or update) or delete the authorization policy on the identity.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
active
boolean
-
- |
-
-
|
-
- Whether or not this rule set should be the active rule set. Only has an impact if state is
- present.If omitted, the active rule set will not be changed.
- If
- True then this rule set will be made active and all others inactive.if
- False then this rule set will be deactivated. Be careful with this as you can end up with no active rule set. |
+
+
+
+
|
+
+ Whether or not this rule set should be the active rule set. Only has an impact if state is
+ present.If omitted, the active rule set will not be changed.
+ If
+ True then this rule set will be made active and all others inactive.if
+ False then this rule set will be deactivated. Be careful with this as you can end up with no active rule set. |
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
force
boolean
-
- |
-
-
|
-
- When deleting a rule set, deactivate it first (AWS prevents deletion of the active rule set).
- |
+
+
+
+
|
+
+ When deleting a rule set, deactivate it first (AWS prevents deletion of the active rule set).
+ |
| + | ||||
|
name
string
- / required
- |
- - | -
- The name of the receipt rule set.
- |
+ / required
+
+ + | +
+ The name of the receipt rule set.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Whether to create (or update) or destroy the receipt rule set.
- |
+
+
+
+
|
+
+ Whether to create (or update) or destroy the receipt rule set.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
present| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
gather_file_shares
boolean
-
- |
-
-
|
-
- Gather file share information for storage gateways in s3 mode.
- |
+
+
+
+
|
+
+ Gather file share information for storage gateways in s3 mode.
+ |
| + | ||||
|
gather_local_disks
boolean
-
- |
-
-
|
-
- Gather local disks attached to the storage gateway.
- |
+
+
+
+
|
+
+ Gather local disks attached to the storage gateway.
+ |
| + | ||||
|
gather_tapes
boolean
-
- |
-
-
|
-
- Gather tape information for storage gateways in tape mode.
- |
+
+
+
+
|
+
+ Gather tape information for storage gateways in tape mode.
+ |
| + | ||||
|
gather_volumes
boolean
-
- |
-
-
|
-
- Gather volume information for storage gateways in iSCSI (cached & stored) modes.
- |
+
+
+
+
|
+
+ Gather volume information for storage gateways in iSCSI (cached & stored) modes.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
-
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
decryption
boolean
-
- |
-
-
|
-
- Work with SecureString type to get plain text secrets
- |
+
+
+
+
|
+
+ Work with SecureString type to get plain text secrets
+ |
| + | ||||
|
description
string
-
- |
- - | -
- Parameter key description.
- |
+
+
+ + | +
+ Parameter key description.
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
key_id
string
-
- |
-
- Default: "alias/aws/ssm"
- |
-
- AWS KMS key to decrypt the secrets.
- The default key (
- alias/aws/ssm) is automatically generated the first time it's requested. |
+
+
+
+ Default: "alias/aws/ssm"
+ |
+
+ AWS KMS key to decrypt the secrets.
+ The default key (
+ alias/aws/ssm) is automatically generated the first time it's requested. |
| + | ||||
|
name
string
- / required
- |
- - | -
- Parameter key name.
- |
+ / required
+
+ + | +
+ Parameter key name.
+ |
| + | ||||
|
overwrite_value
string
-
- |
-
-
|
-
- Option to overwrite an existing value if it already exists.
- |
+
+
+
+
|
+
+ Option to overwrite an existing value if it already exists.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Creates or modifies an existing parameter.
- Deletes a parameter.
- |
+
+
+
+
|
+
+ Creates or modifies an existing parameter.
+ Deletes a parameter.
+ |
| + | ||||
|
string_type
string
-
- |
-
-
|
-
- Parameter String type.
- |
+
+
+
+
|
+
+ Parameter String type.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
value
string
-
- |
- - | -
- Parameter value.
- |
+
+
+ + | +
+ Parameter value.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
action
string
-
- |
-
-
|
-
- Desired action (start or stop) for a state machine execution.
- |
+
+
+
+
|
+
+ Desired action (start or stop) for a state machine execution.
+ |
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
cause
string
-
- |
-
- Default: ""
- |
-
- A detailed explanation of the cause for stopping the execution.
- |
+
+
+
+ Default: ""
+ |
+
+ A detailed explanation of the cause for stopping the execution.
+ |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
error
string
-
- |
-
- Default: ""
- |
-
- The error code of the failure to pass in when stopping the execution.
- |
+
+
+
+ Default: ""
+ |
+
+ The error code of the failure to pass in when stopping the execution.
+ |
| + | ||||
|
execution_arn
string
-
- |
- - | -
- The ARN of the execution you wish to stop.
- |
+
+
+ + | +
+ The ARN of the execution you wish to stop.
+ |
| + | ||||
|
execution_input
json
-
- |
-
- Default: {}
- |
-
- The JSON input data for the execution.
- |
+
+
+
+ Default: {}
+ |
+
+ The JSON input data for the execution.
+ |
| + | ||||
|
name
string
-
- |
- - | -
- Name of the execution.
- |
+
+
+ + | +
+ Name of the execution.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state_machine_arn
string
-
- |
- - | -
- The ARN of the state machine that will be executed.
- |
+
+
+ + | +
+ The ARN of the state machine that will be executed.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
definition
json
-
- |
- - | -
- The Amazon States Language definition of the state machine. See https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html for more information on the Amazon States Language.
- This parameter is required when
- state=present. |
+
+
+ + | +
+ The Amazon States Language definition of the state machine. See https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html for more information on the Amazon States Language.
+ This parameter is required when
+ state=present. |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
name
string
- / required
- |
- - | -
- Name of the state machine
- |
+ / required
+
+ + | +
+ Name of the state machine
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
purge_tags
boolean
-
- |
-
-
|
-
- If yes, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified.
- |
+
+
+
+
|
+
+ If yes, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified.
+ |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
role_arn
string
-
- |
- - | -
- The ARN of the IAM Role that will be used by the state machine for its executions.
- This parameter is required when
- state=present. |
+
+
+ + | +
+ The ARN of the IAM Role that will be used by the state machine for its executions.
+ This parameter is required when
+ state=present. |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Desired state for the state machine
- |
+
+
+
+
|
+
+ Desired state for the state machine
+ |
| + | ||||
|
tags
dictionary
-
- |
- - | -
- A hash/dictionary of tags to add to the new state machine or to add/remove from an existing one.
- |
+
+
+ + | +
+ A hash/dictionary of tags to add to the new state machine or to add/remove from an existing one.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |||
|---|---|---|---|---|---|---|
| + | ||||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
||
| + | ||||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
||
| + | ||||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
||
| + | ||||||
|
filters
list
- / elements=dictionary
- |
- - | -
- A list of the filters against which to match.
- For type=byte, valid keys are field_to_match, position, header, transformation and target_string.
- For type=geo, the only valid key is country.
- For type=ip, the only valid key is ip_address.
- For type=regex, valid keys are field_to_match, transformation and regex_pattern.
- For type=size, valid keys are field_to_match, transformation, comparison and size.
- For type=sql, valid keys are field_to_match and transformation.
- For type=xss, valid keys are field_to_match and transformation.
- Required when state=present.
- |
- ||||
| - | + / elements=dictionary + | ++ | +
+ A list of the filters against which to match.
+ For type=byte, valid keys are field_to_match, position, header, transformation and target_string.
+ For type=geo, the only valid key is country.
+ For type=ip, the only valid key is ip_address.
+ For type=regex, valid keys are field_to_match, transformation and regex_pattern.
+ For type=size, valid keys are field_to_match, transformation, comparison and size.
+ For type=sql, valid keys are field_to_match and transformation.
+ For type=xss, valid keys are field_to_match and transformation.
+ Required when state=present.
+ |
+ |||
| + |
comparison
string
-
- |
-
-
|
-
- What type of comparison to perform.
- Only valid key when type=size.
- |
+
+
+
+
|
+
+ What type of comparison to perform.
+ Only valid key when type=size.
+ |
|
| - | + | |||||
| + |
country
string
-
- |
- - | -
- Value of geo constraint (typically a two letter country code).
- The only valid key when type=geo.
- |
+
+
+ + | +
+ Value of geo constraint (typically a two letter country code).
+ The only valid key when type=geo.
+ |
|
| - | + | |||||
| + |
field_to_match
string
-
- |
-
-
|
-
- The field upon which to perform the match.
- Valid when type=byte, type=regex, type=sql or type=xss.
- |
+
+
+
+
|
+
+ The field upon which to perform the match.
+ Valid when type=byte, type=regex, type=sql or type=xss.
+ |
|
| - | + | |||||
| + |
header
string
-
- |
- - | -
- Which specific header should be matched.
- Required when field_to_match=header.
- Valid when type=byte.
- |
- |||
| - | + + | ++ | +
+ Which specific header should be matched.
+ Required when field_to_match=header.
+ Valid when type=byte.
+ |
+ |||
| + |
ip_address
string
-
- |
- - | -
- An IP Address or CIDR to match.
- The only valid key when type=ip.
- |
+
+
+ + | +
+ An IP Address or CIDR to match.
+ The only valid key when type=ip.
+ |
|
| - | + | |||||
| + |
position
string
-
- |
-
-
|
-
- Where in the field the match needs to occur.
- Only valid when type=byte.
- |
+
+
+
+
|
+
+ Where in the field the match needs to occur.
+ Only valid when type=byte.
+ |
|
| - | + | |||||
| + |
regex_pattern
dictionary
-
- |
- - | -
- A dict describing the regular expressions used to perform the match.
- Only valid when type=regex.
- |
- |||
| - | - | + + | ++ | +
+ A dict describing the regular expressions used to perform the match.
+ Only valid when type=regex.
+ |
+ ||
| + | + |
name
string
-
- |
- - | -
- A name to describe the set of patterns.
- |
+
+
+ + | +
+ A name to describe the set of patterns.
+ |
| - | - | + | ||||
| + | + |
regex_strings
list
- / elements=string
- |
- - | -
- A list of regular expressions to match.
- |
- ||
| - | + / elements=string + | ++ | +
+ A list of regular expressions to match.
+ |
+ |||
| + |
size
integer
-
- |
- - | -
- The size of the field (in bytes).
- Only valid key when type=size.
- |
+
+
+ + | +
+ The size of the field (in bytes).
+ Only valid key when type=size.
+ |
|
| - | + | |||||
| + |
target_string
string
-
- |
- - | -
- The string to search for.
- May be up to 50 bytes.
- Valid when type=byte.
- |
- |||
| - | + + | ++ | +
+ The string to search for.
+ May be up to 50 bytes.
+ Valid when type=byte.
+ |
+ |||
| + |
transformation
string
-
- |
-
-
|
-
- A transform to apply on the field prior to performing the match.
- Valid when type=byte, type=regex, type=sql or type=xss.
- |
- |||
| + + | +
+
|
+
+ A transform to apply on the field prior to performing the match.
+ Valid when type=byte, type=regex, type=sql or type=xss.
+ |
+ ||||
|
name
string
- / required
- |
- - | -
- Name of the Web Application Firewall condition to manage.
- |
+ / required
+
+ + | +
+ Name of the Web Application Firewall condition to manage.
+ |
||
| + | ||||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
||
| + | ||||||
|
purge_filters
boolean
-
- |
-
-
|
-
- Whether to remove existing filters from a condition if not passed in filters.
- |
+
+
+
+
|
+
+ Whether to remove existing filters from a condition if not passed in filters.
+ |
||
| + | ||||||
|
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 |
+
+
+ + | +
+ 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 |
||
| + | ||||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
||
| + | ||||||
|
state
string
-
- |
-
-
|
-
- Whether the condition should be
- present or absent. |
+
+
+
+
|
+
+ Whether the condition should be
+ present or absent. |
||
| + | ||||||
|
type
string
- / required
- |
-
-
|
-
- The type of matching to perform.
- |
+ / required
+
+
+
|
+
+ The type of matching to perform.
+ |
||
| + | ||||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
||
| + | ||||||
|
waf_regional
boolean
-
- |
-
-
|
-
- Whether to use waf-regional module.
- |
- ||||
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
name
string
-
- |
- - | -
- The name of a Web Application Firewall.
- |
+
+
+ + | +
+ The name of a Web Application Firewall.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
waf_regional
boolean
-
- |
-
-
|
-
- Whether to use the waf-regional module.
- |
+
+
+
+
|
+
+ Whether to use the waf-regional module.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
conditions
list
- / elements=dictionary
- |
- - | -
- List of conditions used in the rule. community.aws.aws_waf_condition can be used to create new conditions.
- |
+ / elements=dictionary
+
+ + | +
+ List of conditions used in the rule. community.aws.aws_waf_condition can be used to create new conditions.
+ |
|
| - | + | ||||
| + |
condition
string
- / required
- |
- - | -
- The name of the condition. The condition must already exist.
- |
+ / required
+
+ + | +
+ The name of the condition. The condition must already exist.
+ |
| - | + | ||||
| + |
negated
boolean
- / required
- |
-
-
|
-
- Whether the condition should be negated.
- |
+ / required
+
+
+
|
+
+ Whether the condition should be negated.
+ |
| - | + | ||||
| + |
type
string
- / required
- |
-
-
|
-
- The type of rule to match.
- |
+ / required
+
+
+
|
+
+ The type of rule to match.
+ |
| + + | |||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
metric_name
string
-
- |
- - | -
- A friendly name or description for the metrics for the rule.
- The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace.
- You can't change metric_name after you create the rule.
- Defaults to the same as name with disallowed characters removed.
- |
+
+
+ + | +
+ A friendly name or description for the metrics for the rule.
+ The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace.
+ You can't change metric_name after you create the rule.
+ Defaults to the same as name with disallowed characters removed.
+ |
|
| + | |||||
|
name
string
- / required
- |
- - | -
- Name of the Web Application Firewall rule.
- |
+ / required
+
+ + | +
+ Name of the Web Application Firewall rule.
+ |
|
| + | |||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
purge_conditions
boolean
-
- |
-
-
|
-
- Whether or not to remove conditions that are not passed when updating `conditions`.
- |
+
+
+
+
|
+
+ Whether or not to remove conditions that are not passed when updating `conditions`.
+ |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
state
string
-
- |
-
-
|
-
- Whether the rule should be present or absent.
- |
+
+
+
+
|
+
+ Whether the rule should be present or absent.
+ |
|
| + | |||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
|
| + | |||||
|
waf_regional
boolean
-
- |
-
-
|
-
- Whether to use waf-regional module.
- |
+
+
+
+
|
+
+ Whether to use waf-regional module.
+ |
|
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
|
| + | |||||
|
default_action
string
-
- |
-
-
|
-
- The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule objects that are associated with the WebACL.
- |
+
+
+
+
|
+
+ The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule objects that are associated with the WebACL.
+ |
|
| + | |||||
|
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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
metric_name
string
-
- |
- - | -
- A friendly name or description for the metrics for this WebACL.
- The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace.
- You can't change metric_name after you create the WebACL.
- Metric name will default to name with disallowed characters stripped out.
- |
+
+
+ + | +
+ A friendly name or description for the metrics for this WebACL.
+ The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace.
+ You can't change metric_name after you create the WebACL.
+ Metric name will default to name with disallowed characters stripped out.
+ |
|
| + | |||||
|
name
string
- / required
- |
- - | -
- Name of the Web Application Firewall ACL to manage.
- |
+ / required
+
+ + | +
+ Name of the Web Application Firewall ACL to manage.
+ |
|
| + | |||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
purge_rules
boolean
-
- |
-
-
|
-
- Whether to remove rules that aren't passed with rules.
- |
+
+
+
+
|
+
+ Whether to remove rules that aren't passed with rules.
+ |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
rules
list
- / elements=dictionary
- |
- - | -
- A list of rules that the Web ACL will enforce.
- |
+ / elements=dictionary
+
+ + | +
+ A list of rules that the Web ACL will enforce.
+ |
|
| - | + | ||||
| + |
action
string
- / required
- |
- - | -
- The action to perform.
- |
+ / required
+
+ + | +
+ The action to perform.
+ |
| - | + | ||||
| + |
name
string
- / required
- |
- - | -
- Name of the rule.
- |
+ / required
+
+ + | +
+ Name of the rule.
+ |
| - | + | ||||
| + |
priority
integer
- / required
- |
- - | -
- The priority of the action. Priorities must be unique. Lower numbered priorities are evaluated first.
- |
+ / required
+
+ + | +
+ The priority of the action. Priorities must be unique. Lower numbered priorities are evaluated first.
+ |
| - | + | ||||
| + |
type
string
-
- |
-
-
|
-
- The type of rule.
- |
+
+
+
+
|
+
+ The type of rule.
+ |
| + + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
state
string
-
- |
-
-
|
-
- Whether the Web ACL should be present or absent.
- |
+
+
+
+
|
+
+ Whether the Web ACL should be present or absent.
+ |
|
| + | |||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
|
| + | |||||
|
waf_regional
boolean
-
- |
-
-
|
-
- Whether to use waf-regional module.
- |
+
+
+
+
|
+
+ Whether to use waf-regional module.
+ |
|
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
accounts
list
- / elements=string
- |
- - | -
- A list of AWS accounts in which to create instance of CloudFormation stacks.
- At least one region must be specified to create a stack set. On updates, if fewer regions are specified only the specified regions will have their stack instances updated.
- |
+ / elements=string
+
+ + | +
+ A list of AWS accounts in which to create instance of CloudFormation stacks.
+ At least one region must be specified to create a stack set. On updates, if fewer regions are specified only the specified regions will have their stack instances updated.
+ |
|
| + | |||||
|
administration_role_arn
string
-
- |
- - | -
- ARN of the administration role, meaning the role that CloudFormation Stack Sets use to assume the roles in your child accounts.
- This defaults to
- arn:aws:iam::{{ account ID }}:role/AWSCloudFormationStackSetAdministrationRole where {{ account ID }} is replaced with the account number of the current IAM role/user/STS credentials.aliases: admin_role_arn, admin_role, administration_role |
+
+
+ + | +
+ ARN of the administration role, meaning the role that CloudFormation Stack Sets use to assume the roles in your child accounts.
+ This defaults to
+ arn:aws:iam::{{ account ID }}:role/AWSCloudFormationStackSetAdministrationRole where {{ account ID }} is replaced with the account number of the current IAM role/user/STS credentials.aliases: admin_role_arn, admin_role, administration_role |
|
| + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
capabilities
list
- / elements=string
- |
-
-
|
-
- Capabilities allow stacks to create and modify IAM resources, which may include adding users or roles.
- Currently the only available values are 'CAPABILITY_IAM' and 'CAPABILITY_NAMED_IAM'. Either or both may be provided.
- The following resources require that one or both of these parameters is specified: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, AWS::IAM::UserToGroupAddition
- |
+ / elements=string
+
+
+
|
+
+ Capabilities allow stacks to create and modify IAM resources, which may include adding users or roles.
+ Currently the only available values are 'CAPABILITY_IAM' and 'CAPABILITY_NAMED_IAM'. Either or both may be provided.
+ The following resources require that one or both of these parameters is specified: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, AWS::IAM::UserToGroupAddition
+ |
|
| + | |||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
|
| + | |||||
|
description
string
-
- |
- - | -
- A description of what this stack set creates.
- |
+
+
+ + | +
+ A description of what this stack set creates.
+ |
|
| + | |||||
|
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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
execution_role_name
string
-
- |
- - | -
- ARN of the execution role, meaning the role that CloudFormation Stack Sets assumes in your child accounts.
- This MUST NOT be an ARN, and the roles must exist in each child account specified.
- The default name for the execution role is
- AWSCloudFormationStackSetExecutionRolealiases: exec_role_name, exec_role, execution_role |
- |||
| + + | ++ | +
+ ARN of the execution role, meaning the role that CloudFormation Stack Sets assumes in your child accounts.
+ This MUST NOT be an ARN, and the roles must exist in each child account specified.
+ The default name for the execution role is
+ AWSCloudFormationStackSetExecutionRolealiases: exec_role_name, exec_role, execution_role |
+ |||
|
failure_tolerance
dictionary
-
- |
- - | -
- Settings to change what is considered "failed" when running stack instance updates, and how many to do at a time.
- |
- |||
| - | + + | ++ | +
+ Settings to change what is considered "failed" when running stack instance updates, and how many to do at a time.
+ |
+ ||
| + |
fail_count
integer
-
- |
- - | -
- The number of accounts, per region, for which this operation can fail before CloudFormation stops the operation in that region.
- You must specify one of fail_count and fail_percentage.
- |
+
+
+ + | +
+ The number of accounts, per region, for which this operation can fail before CloudFormation stops the operation in that region.
+ You must specify one of fail_count and fail_percentage.
+ |
| - | + | ||||
| + |
fail_percentage
integer
-
- |
- - | -
- The percentage of accounts, per region, for which this stack operation can fail before CloudFormation stops the operation in that region.
- You must specify one of fail_count and fail_percentage.
- |
+
+
+ + | +
+ The percentage of accounts, per region, for which this stack operation can fail before CloudFormation stops the operation in that region.
+ You must specify one of fail_count and fail_percentage.
+ |
| - | + | ||||
| + |
parallel_count
integer
-
- |
- - | -
- The maximum number of accounts in which to perform this operation at one time.
- parallel_count may be at most one more than the fail_count.
- You must specify one of parallel_count and parallel_percentage.
- Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual count may be lower.
- |
- ||
| - | + + | ++ | +
+ The maximum number of accounts in which to perform this operation at one time.
+ parallel_count may be at most one more than the fail_count.
+ You must specify one of parallel_count and parallel_percentage.
+ Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual count may be lower.
+ |
+ ||
| + |
parallel_percentage
integer
-
- |
- - | -
- The maximum percentage of accounts in which to perform this operation at one time.
- You must specify one of parallel_count and parallel_percentage.
- Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual percentage may be lower.
- |
- ||
| + + | ++ | +
+ The maximum percentage of accounts in which to perform this operation at one time.
+ You must specify one of parallel_count and parallel_percentage.
+ Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual percentage may be lower.
+ |
+ |||
|
name
string
- / required
- |
- - | -
- Name of the CloudFormation stack set.
- |
+ / required
+
+ + | +
+ Name of the CloudFormation stack set.
+ |
|
| + | |||||
|
parameters
dictionary
-
- |
-
- Default: {}
- |
-
- A list of hashes of all the template variables for the stack. The value can be a string or a dict.
- Dict can be used to set additional template parameter attributes like UsePreviousValue (see example).
- |
+
+
+
+ Default: {}
+ |
+
+ A list of hashes of all the template variables for the stack. The value can be a string or a dict.
+ Dict can be used to set additional template parameter attributes like UsePreviousValue (see example).
+ |
|
| + | |||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
purge_stacks
boolean
-
- |
-
-
|
-
- Only applicable when state=absent. Sets whether, when deleting a stack set, the stack instances should also be deleted.
- By default, instances will be deleted. To keep stacks when stack set is deleted set purge_stacks=false.
- |
+
+
+
+
|
+
+ Only applicable when state=absent. Sets whether, when deleting a stack set, the stack instances should also be deleted.
+ By default, instances will be deleted. To keep stacks when stack set is deleted set purge_stacks=false.
+ |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
regions
list
- / elements=string
- |
- - | -
- A list of AWS regions to create instances of a stack in. The region parameter chooses where the Stack Set is created, and regions specifies the region for stack instances.
- At least one region must be specified to create a stack set. On updates, if fewer regions are specified only the specified regions will have their stack instances updated.
- |
+ / elements=string
+
+ + | +
+ A list of AWS regions to create instances of a stack in. The region parameter chooses where the Stack Set is created, and regions specifies the region for stack instances.
+ At least one region must be specified to create a stack set. On updates, if fewer regions are specified only the specified regions will have their stack instances updated.
+ |
|
| + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
state
string
-
- |
-
-
|
-
- If state=present, stack will be created. If state=present and if stack exists and template has changed, it will be updated. If state=absent, stack will be removed.
- |
+
+
+
+
|
+
+ If state=present, stack will be created. If state=present and if stack exists and template has changed, it will be updated. If state=absent, stack will be removed.
+ |
|
| + | |||||
|
tags
dictionary
-
- |
- - | -
- Dictionary of tags to associate with stack and its resources during stack creation.
- Can be updated later, updating tags removes previous entries.
- |
+
+
+ + | +
+ Dictionary of tags to associate with stack and its resources during stack creation.
+ Can be updated later, updating tags removes previous entries.
+ |
|
| + | |||||
|
template
path
-
- |
- - | -
- The local path of the CloudFormation template.
- This must be the full path to the file, relative to the working directory. If using roles this may look like
- roles/cloudformation/files/cloudformation-example.json.If state=present and the stack does not exist yet, either template, template_body or template_url must be specified (but only one of them).
- If state=present, the stack does exist, and neither template, template_body nor template_url are specified, the previous template will be reused.
- |
- |||
| + + | ++ | +
+ The local path of the CloudFormation template.
+ This must be the full path to the file, relative to the working directory. If using roles this may look like
+ roles/cloudformation/files/cloudformation-example.json.If state=present and the stack does not exist yet, either template, template_body or template_url must be specified (but only one of them).
+ If state=present, the stack does exist, and neither template, template_body nor template_url are specified, the previous template will be reused.
+ |
+ |||
|
template_body
string
-
- |
- - | -
- Template body. Use this to pass in the actual body of the CloudFormation template.
- If state=present and the stack does not exist yet, either template, template_body or template_url must be specified (but only one of them).
- If state=present, the stack does exist, and neither template, template_body nor template_url are specified, the previous template will be reused.
- |
+
+
+ + | +
+ Template body. Use this to pass in the actual body of the CloudFormation template.
+ If state=present and the stack does not exist yet, either template, template_body or template_url must be specified (but only one of them).
+ If state=present, the stack does exist, and neither template, template_body nor template_url are specified, the previous template will be reused.
+ |
|
| + | |||||
|
template_url
string
-
- |
- - | -
- Location of file containing the template body.
- The URL must point to a template (max size 307,200 bytes) located in an S3 bucket in the same region as the stack.
- If state=present and the stack does not exist yet, either template, template_body or template_url must be specified (but only one of them).
- If state=present, the stack does exist, and neither template, template_body nor template_url are specified, the previous template will be reused.
- |
- |||
| + + | ++ | +
+ Location of file containing the template body.
+ The URL must point to a template (max size 307,200 bytes) located in an S3 bucket in the same region as the stack.
+ If state=present and the stack does not exist yet, either template, template_body or template_url must be specified (but only one of them).
+ If state=present, the stack does exist, and neither template, template_body nor template_url are specified, the previous template will be reused.
+ |
+ |||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
|
| + | |||||
|
wait
boolean
-
- |
-
-
|
-
- Whether or not to wait for stack operation to complete. This includes waiting for stack instances to reach UPDATE_COMPLETE status.
- If you choose not to wait, this module will not notify when stack operations fail because it will not wait for them to finish.
- |
+
+
+
+
|
+
+ Whether or not to wait for stack operation to complete. This includes waiting for stack instances to reach UPDATE_COMPLETE status.
+ If you choose not to wait, this module will not notify when stack operations fail because it will not wait for them to finish.
+ |
|
| + | |||||
|
wait_timeout
integer
-
- |
-
- Default: 900
- |
-
- How long to wait (in seconds) for stacks to complete create/update/delete operations.
- |
- |||
| Parameter | Choices/Defaults | -Comments | +Comments | ||||
|---|---|---|---|---|---|---|---|
| + | |||||||
|
alias
string
-
- |
- - | -
- The name of an alias (CNAME) that is used in a distribution. This is used to effectively reference a distribution by its alias as an alias can only be used by one distribution per AWS account. This variable avoids having to provide the distribution_id as well as the e_tag, or caller_reference of an existing distribution.
- |
+
+
+ + | +
+ The name of an alias (CNAME) that is used in a distribution. This is used to effectively reference a distribution by its alias as an alias can only be used by one distribution per AWS account. This variable avoids having to provide the distribution_id as well as the e_tag, or caller_reference of an existing distribution.
+ |
|||
| + | |||||||
|
aliases
list
- / elements=string
- |
- - | -
- A list) of domain name aliases (CNAMEs) as strings to be used for the distribution.
- Each alias must be unique across all distribution for the AWS account.
- |
+ / elements=string
+
+ + | +
+ A list) of domain name aliases (CNAMEs) as strings to be used for the distribution.
+ Each alias must be unique across all distribution for the AWS account.
+ |
|||
| + | |||||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|||
| + | |||||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|||
| + | |||||||
|
cache_behaviors
list
- / elements=dictionary
- |
- - | -
- A list of dictionaries describing the cache behaviors for the distribution.
- The order of the list is preserved across runs unless purge_cache_behaviors is enabled.
- |
- |||||
| - | + / elements=dictionary + | ++ | +
+ A list of dictionaries describing the cache behaviors for the distribution.
+ The order of the list is preserved across runs unless purge_cache_behaviors is enabled.
+ |
+ ||||
| + |
forwarded_values
dictionary
-
- |
- - | -
- A dict that specifies how CloudFront handles query strings and cookies.
- |
- ||||
| - | - | + + | ++ | +
+ A dict that specifies how CloudFront handles query strings and cookies.
+ |
+ |||
| + | + |
allowed_methods
dictionary
-
- |
- - | -
- A dict that controls which HTTP methods CloudFront processes and forwards.
- |
- |||
| - | - | - | + + | ++ | +
+ A dict that controls which HTTP methods CloudFront processes and forwards.
+ |
+ ||
| + | + | + |
cached_methods
list
- / elements=string
- |
- - | -
- A list of HTTP methods that you want CloudFront to apply caching to.
- This can either be
- [GET,HEAD], or [GET,HEAD,OPTIONS]. |
+ / elements=string
+
+ + | +
+ A list of HTTP methods that you want CloudFront to apply caching to.
+ This can either be
+ [GET,HEAD], or [GET,HEAD,OPTIONS]. |
| - | - | - | + | ||||
| + | + | + |
items
list
- / elements=string
- |
- - | -
- A list of HTTP methods that you want CloudFront to process and forward.
- |
- ||
| - | - | + / elements=string + | ++ | +
+ A list of HTTP methods that you want CloudFront to process and forward.
+ |
+ |||
| + | + |
compress
boolean
-
- |
-
-
|
-
- Whether you want CloudFront to automatically compress files.
- |
- |||
| - | - | + + | +
+
|
+
+ Whether you want CloudFront to automatically compress files.
+ |
+ |||
| + | + |
cookies
dictionary
-
- |
- - | -
- A dict that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones.
- |
- |||
| - | - | - | + + | ++ | +
+ A dict that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones.
+ |
+ ||
| + | + | + |
forward
string
-
- |
- - | -
- Specifies which cookies to forward to the origin for this cache behavior.
- Valid values are
- all, none, or whitelist. |
+
+
+ + | +
+ Specifies which cookies to forward to the origin for this cache behavior.
+ Valid values are
+ all, none, or whitelist. |
| - | - | - | + | ||||
| + | + | + |
whitelisted_names
list
- / elements=string
- |
- - | -
- A list of coockies to forward to the origin for this cache behavior.
- |
- ||
| - | - | + / elements=string + | ++ | +
+ A list of cookies to forward to the origin for this cache behavior.
+ |
+ |||
| + | + |
default_ttl
integer
-
- |
- - | -
- The default amount of time that you want objects to stay in CloudFront caches.
- |
+
+
+ + | +
+ The default amount of time that you want objects to stay in CloudFront caches.
+ |
|
| - | - | + | |||||
| + | + |
field_level_encryption_id
string
-
- |
- - | -
- The field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data.
- |
+
+
+ + | +
+ The field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data.
+ |
|
| - | - | + | |||||
| + | + |
headers
list
- / elements=string
- |
- - | -
- A list of headers to forward to the origin for this cache behavior.
- To forward all headers use a list containing a single element '*' (
- ['*']) |
+ / elements=string
+
+ + | +
+ A list of headers to forward to the origin for this cache behavior.
+ To forward all headers use a list containing a single element '*' (
+ ['*']) |
|
| - | - | + | |||||
| + | + |
lambda_function_associations
list
- / elements=dictionary
- |
- - | -
- A list of Lambda function associations to use for this cache behavior.
- |
- |||
| - | - | - | + / elements=dictionary + | ++ | +
+ A list of Lambda function associations to use for this cache behavior.
+ |
+ ||
| + | + | + |
event_type
string
-
- |
- - | -
- Specifies the event type that triggers a Lambda function invocation.
- This can be
- viewer-request, origin-request, origin-response or viewer-response. |
+
+
+ + | +
+ Specifies the event type that triggers a Lambda function invocation.
+ This can be
+ viewer-request, origin-request, origin-response or viewer-response. |
| - | - | - | + | ||||
| + | + | + |
lambda_function_arn
string
-
- |
- - | -
- The ARN of the Lambda function.
- |
- ||
| - | - | + + | ++ | +
+ The ARN of the Lambda function.
+ |
+ |||
| + | + |
max_ttl
integer
-
- |
- - | -
- The maximum amount of time that you want objects to stay in CloudFront caches.
- |
+
+
+ + | +
+ The maximum amount of time that you want objects to stay in CloudFront caches.
+ |
|
| - | - | + | |||||
| + | + |
min_ttl
integer
-
- |
- - | -
- The minimum amount of time that you want objects to stay in CloudFront caches.
- |
+
+
+ + | +
+ The minimum amount of time that you want objects to stay in CloudFront caches.
+ |
|
| - | - | + | |||||
| + | + |
query_string
boolean
-
- |
-
-
|
-
- Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior.
- |
- |||
| - | - | + + | +
+
|
+
+ Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior.
+ |
+ |||
| + | + |
query_string_cache_keys
list
- / elements=string
- |
- - | -
- A list that contains the query string parameters you want CloudFront to use as a basis for caching for a cache behavior.
- |
+ / elements=string
+
+ + | +
+ A list that contains the query string parameters you want CloudFront to use as a basis for caching for a cache behavior.
+ |
|
| - | - | + | |||||
| + | + |
smooth_streaming
boolean
-
- |
-
-
|
-
- Whether you want to distribute media files in the Microsoft Smooth Streaming format.
- |
- |||
| - | - | + + | +
+
|
+
+ Whether you want to distribute media files in the Microsoft Smooth Streaming format.
+ |
+ |||
| + | + |
trusted_signers
dictionary
-
- |
- - | -
- A dict that specifies the AWS accounts that you want to allow to create signed URLs for private content.
- |
- |||
| - | - | - | + + | ++ | +
+ A dict that specifies the AWS accounts that you want to allow to create signed URLs for private content.
+ |
+ ||
| + | + | + |
enabled
boolean
-
- |
-
-
|
-
- Whether you want to require viewers to use signed URLs to access the files specified by path_pattern and target_origin_id
- |
- ||
| - | - | - | + + | +
+
|
+
+ Whether you want to require viewers to use signed URLs to access the files specified by path_pattern and target_origin_id
+ |
+ ||
| + | + | + |
items
list
- / elements=string
- |
- - | -
- A list of trusted signers for this cache behavior.
- |
- ||
| - | - | + / elements=string + | ++ | +
+ A list of trusted signers for this cache behavior.
+ |
+ |||
| + | + |
viewer_protocol_policy
string
-
- |
- - | -
- The protocol that viewers can use to access the files in the origin specified by target_origin_id when a request matches path_pattern.
- Valid values are
- allow-all, redirect-to-https and https-only. |
- |||
| - | + + | ++ | +
+ The protocol that viewers can use to access the files in the origin specified by target_origin_id when a request matches path_pattern.
+ Valid values are
+ allow-all, redirect-to-https and https-only. |
+ ||||
| + |
path_pattern
string
-
- |
- - | -
- The pattern that specifies which requests to apply the behavior to.
- |
+
+
+ + | +
+ The pattern that specifies which requests to apply the behavior to.
+ |
||
| - | + | ||||||
| + |
target_origin_id
string
-
- |
- - | -
- The ID of the origin that you want CloudFront to route requests to by default.
- |
- ||||
| + + | ++ | +
+ The ID of the origin that you want CloudFront to route requests to by default.
+ |
+ |||||
|
caller_reference
string
-
- |
- - | -
- A unique identifier for creating and updating CloudFront distributions.
- Each caller reference must be unique across all distributions. e.g. a caller reference used in a web distribution cannot be reused in a streaming distribution. This parameter can be used instead of distribution_id to reference an existing distribution. If not specified, this defaults to a datetime stamp of the format
- YYYY-MM-DDTHH:MM:SS.ffffff. |
+
+
+ + | +
+ A unique identifier for creating and updating CloudFront distributions.
+ Each caller reference must be unique across all distributions. e.g. a caller reference used in a web distribution cannot be reused in a streaming distribution. This parameter can be used instead of distribution_id to reference an existing distribution. If not specified, this defaults to a datetime stamp of the format
+ YYYY-MM-DDTHH:MM:SS.ffffff. |
|||
| + | |||||||
|
comment
string
-
- |
- - | -
- A comment that describes the CloudFront distribution.
- If not specified, it defaults to a generic message that it has been created with Ansible, and a datetime stamp.
- |
+
+
+ + | +
+ A comment that describes the CloudFront distribution.
+ If not specified, it defaults to a generic message that it has been created with Ansible, and a datetime stamp.
+ |
|||
| + | |||||||
|
custom_error_responses
list
- / elements=dictionary
- |
- - | -
- A config element that is a list[] of complex custom error responses to be specified for the distribution.
- This attribute configures custom http error messages returned to the user.
- |
- |||||
| - | + / elements=dictionary + | ++ | +
+ A config element that is a list[] of complex custom error responses to be specified for the distribution.
+ This attribute configures custom http error messages returned to the user.
+ |
+ ||||
| + |
error_caching_min_ttl
integer
-
- |
- - | -
- The length of time (in seconds) that CloudFront will cache status codes for.
- |
+
+
+ + | +
+ The length of time (in seconds) that CloudFront will cache status codes for.
+ |
||
| - | + | ||||||
| + |
error_code
integer
-
- |
- - | -
- The error code the custom error page is for.
- |
+
+
+ + | +
+ The error code the custom error page is for.
+ |
||
| - | + | ||||||
| + |
response_code
integer
-
- |
- - | -
- The HTTP status code that CloudFront should return to a user when the origin returns the HTTP status code specified by error_code.
- |
+
+
+ + | +
+ The HTTP status code that CloudFront should return to a user when the origin returns the HTTP status code specified by error_code.
+ |
||
| - | + | ||||||
| + |
response_page_path
string
-
- |
- - | -
- The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by error_code.
- |
- ||||
| + + | ++ | +
+ The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by error_code.
+ |
+ |||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
|||
| + | |||||||
|
default_cache_behavior
dictionary
-
- |
- - | -
- A dict specifying the default cache behavior of the distribution.
- If not specified, the target_origin_id is defined as the target_origin_id of the first valid cache_behavior in cache_behaviors with defaults.
- |
- |||||
| - | + + | ++ | +
+ A dict specifying the default cache behavior of the distribution.
+ If not specified, the target_origin_id is defined as the target_origin_id of the first valid cache_behavior in cache_behaviors with defaults.
+ |
+ ||||
| + |
forwarded_values
dictionary
-
- |
- - | -
- A dict that specifies how CloudFront handles query strings and cookies.
- |
- ||||
| - | - | + + | ++ | +
+ A dict that specifies how CloudFront handles query strings and cookies.
+ |
+ |||
| + | + |
allowed_methods
dictionary
-
- |
- - | -
- A dict that controls which HTTP methods CloudFront processes and forwards.
- |
- |||
| - | - | - | + + | ++ | +
+ A dict that controls which HTTP methods CloudFront processes and forwards.
+ |
+ ||
| + | + | + |
cached_methods
list
- / elements=string
- |
- - | -
- A list of HTTP methods that you want CloudFront to apply caching to.
- This can either be
- [GET,HEAD], or [GET,HEAD,OPTIONS]. |
+ / elements=string
+
+ + | +
+ A list of HTTP methods that you want CloudFront to apply caching to.
+ This can either be
+ [GET,HEAD], or [GET,HEAD,OPTIONS]. |
| - | - | - | + | ||||
| + | + | + |
items
list
- / elements=string
- |
- - | -
- A list of HTTP methods that you want CloudFront to process and forward.
- |
- ||
| - | - | + / elements=string + | ++ | +
+ A list of HTTP methods that you want CloudFront to process and forward.
+ |
+ |||
| + | + |
compress
boolean
-
- |
-
-
|
-
- Whether you want CloudFront to automatically compress files.
- |
- |||
| - | - | + + | +
+
|
+
+ Whether you want CloudFront to automatically compress files.
+ |
+ |||
| + | + |
cookies
dictionary
-
- |
- - | -
- A dict that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones.
- |
- |||
| - | - | - | + + | ++ | +
+ A dict that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones.
+ |
+ ||
| + | + | + |
forward
string
-
- |
- - | -
- Specifies which cookies to forward to the origin for this cache behavior.
- Valid values are
- all, none, or whitelist. |
+
+
+ + | +
+ Specifies which cookies to forward to the origin for this cache behavior.
+ Valid values are
+ all, none, or whitelist. |
| - | - | - | + | ||||
| + | + | + |
whitelisted_names
list
- / elements=string
- |
- - | -
- A list of coockies to forward to the origin for this cache behavior.
- |
- ||
| - | - | + / elements=string + | ++ | +
+ A list of cookies to forward to the origin for this cache behavior.
+ |
+ |||
| + | + |
default_ttl
integer
-
- |
- - | -
- The default amount of time that you want objects to stay in CloudFront caches.
- |
+
+
+ + | +
+ The default amount of time that you want objects to stay in CloudFront caches.
+ |
|
| - | - | + | |||||
| + | + |
field_level_encryption_id
string
-
- |
- - | -
- The field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data.
- |
+
+
+ + | +
+ The field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data.
+ |
|
| - | - | + | |||||
| + | + |
headers
list
- / elements=string
- |
- - | -
- A list of headers to forward to the origin for this cache behavior.
- To forward all headers use a list containing a single element '*' (
- ['*']) |
+ / elements=string
+
+ + | +
+ A list of headers to forward to the origin for this cache behavior.
+ To forward all headers use a list containing a single element '*' (
+ ['*']) |
|
| - | - | + | |||||
| + | + |
lambda_function_associations
list
- / elements=dictionary
- |
- - | -
- A list of Lambda function associations to use for this cache behavior.
- |
- |||
| - | - | - | + / elements=dictionary + | ++ | +
+ A list of Lambda function associations to use for this cache behavior.
+ |
+ ||
| + | + | + |
event_type
string
-
- |
- - | -
- Specifies the event type that triggers a Lambda function invocation.
- This can be
- viewer-request, origin-request, origin-response or viewer-response. |
+
+
+ + | +
+ Specifies the event type that triggers a Lambda function invocation.
+ This can be
+ viewer-request, origin-request, origin-response or viewer-response. |
| - | - | - | + | ||||
| + | + | + |
lambda_function_arn
string
-
- |
- - | -
- The ARN of the Lambda function.
- |
- ||
| - | - | + + | ++ | +
+ The ARN of the Lambda function.
+ |
+ |||
| + | + |
max_ttl
integer
-
- |
- - | -
- The maximum amount of time that you want objects to stay in CloudFront caches.
- |
+
+
+ + | +
+ The maximum amount of time that you want objects to stay in CloudFront caches.
+ |
|
| - | - | + | |||||
| + | + |
min_ttl
integer
-
- |
- - | -
- The minimum amount of time that you want objects to stay in CloudFront caches.
- |
+
+
+ + | +
+ The minimum amount of time that you want objects to stay in CloudFront caches.
+ |
|
| - | - | + | |||||
| + | + |
query_string
boolean
-
- |
-
-
|
-
- Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior.
- |
- |||
| - | - | + + | +
+
|
+
+ Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior.
+ |
+ |||
| + | + |
query_string_cache_keys
list
- / elements=string
- |
- - | -
- A list that contains the query string parameters you want CloudFront to use as a basis for caching for a cache behavior.
- |
+ / elements=string
+
+ + | +
+ A list that contains the query string parameters you want CloudFront to use as a basis for caching for a cache behavior.
+ |
|
| - | - | + | |||||
| + | + |
smooth_streaming
boolean
-
- |
-
-
|
-
- Whether you want to distribute media files in the Microsoft Smooth Streaming format.
- |
- |||
| - | - | + + | +
+
|
+
+ Whether you want to distribute media files in the Microsoft Smooth Streaming format.
+ |
+ |||
| + | + |
trusted_signers
dictionary
-
- |
- - | -
- A dict that specifies the AWS accounts that you want to allow to create signed URLs for private content.
- |
- |||
| - | - | - | + + | ++ | +
+ A dict that specifies the AWS accounts that you want to allow to create signed URLs for private content.
+ |
+ ||
| + | + | + |
enabled
boolean
-
- |
-
-
|
-
- Whether you want to require viewers to use signed URLs to access the files specified by target_origin_id
- |
- ||
| - | - | - | + + | +
+
|
+
+ Whether you want to require viewers to use signed URLs to access the files specified by target_origin_id
+ |
+ ||
| + | + | + |
items
list
- / elements=string
- |
- - | -
- A list of trusted signers for this cache behavior.
- |
- ||
| - | - | + / elements=string + | ++ | +
+ A list of trusted signers for this cache behavior.
+ |
+ |||
| + | + |
viewer_protocol_policy
string
-
- |
- - | -
- The protocol that viewers can use to access the files in the origin specified by target_origin_id.
- Valid values are
- allow-all, redirect-to-https and https-only. |
- |||
| - | + + | ++ | +
+ The protocol that viewers can use to access the files in the origin specified by target_origin_id.
+ Valid values are
+ allow-all, redirect-to-https and https-only. |
+ ||||
| + |
target_origin_id
string
-
- |
- - | -
- The ID of the origin that you want CloudFront to route requests to by default.
- |
- ||||
| + + | ++ | +
+ The ID of the origin that you want CloudFront to route requests to by default.
+ |
+ |||||
|
default_origin_domain_name
string
-
- |
- - | -
- The domain name to use for an origin if no origins have been specified.
- Should only be used on a first run of generating a distribution and not on subsequent runs.
- Should not be used in conjunction with distribution_id, caller_reference or alias.
- |
+
+
+ + | +
+ The domain name to use for an origin if no origins have been specified.
+ Should only be used on a first run of generating a distribution and not on subsequent runs.
+ Should not be used in conjunction with distribution_id, caller_reference or alias.
+ |
|||
| + | |||||||
|
default_origin_path
string
-
- |
- - | -
- The default origin path to specify for an origin if no origins have been specified. Defaults to empty if not specified.
- |
+
+
+ + | +
+ The default origin path to specify for an origin if no origins have been specified. Defaults to empty if not specified.
+ |
|||
| + | |||||||
|
default_root_object
string
-
- |
- - | -
- A config element that specifies the path to request when the user requests the origin.
- e.g. if specified as 'index.html', this maps to www.example.com/index.html when www.example.com is called by the user.
- This prevents the entire distribution origin from being exposed at the root.
- |
+
+
+ + | +
+ A config element that specifies the path to request when the user requests the origin.
+ e.g. if specified as 'index.html', this maps to www.example.com/index.html when www.example.com is called by the user.
+ This prevents the entire distribution origin from being exposed at the root.
+ |
|||
| + | |||||||
|
distribution_id
string
-
- |
- - | -
- The ID of the CloudFront distribution.
- This parameter can be exchanged with alias or caller_reference and is used in conjunction with e_tag.
- |
+
+
+ + | +
+ The ID of the CloudFront distribution.
+ This parameter can be exchanged with alias or caller_reference and is used in conjunction with e_tag.
+ |
|||
| + | |||||||
|
e_tag
string
-
- |
- - | -
- A unique identifier of a modified or existing distribution. Used in conjunction with distribution_id.
- Is determined automatically if not specified.
- |
+
+
+ + | +
+ A unique identifier of a modified or existing distribution. Used in conjunction with distribution_id.
+ Is determined automatically if not specified.
+ |
|||
| + | |||||||
|
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.
- |
+
+
+ + | +
+ 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 |
|||
| + | |||||||
|
enabled
boolean
-
- |
-
-
|
-
- A boolean value that specifies whether the distribution is enabled or disabled.
- |
+
+
+
+
|
+
+ A boolean value that specifies whether the distribution is enabled or disabled.
+ |
|||
| + | |||||||
|
http_version
string
-
- |
- - | -
- The version of the http protocol to use for the distribution.
- AWS defaults this to
- http2.Valid values are
- http1.1 and http2 |
+
+
+ + | +
+ The version of the http protocol to use for the distribution.
+ AWS defaults this to
+ http2.Valid values are
+ http1.1 and http2 |
|||
| + | |||||||
|
ipv6_enabled
boolean
-
- |
-
-
|
-
- Determines whether IPv6 support is enabled or not.
- |
+
+
+
+
|
+
+ Determines whether IPv6 support is enabled or not.
+ |
|||
| + | |||||||
|
logging
dictionary
-
- |
- - | -
- A config element that is a complex object that defines logging for the distribution.
- |
- |||||
| - | + + | ++ | +
+ A config element that is a complex object that defines logging for the distribution.
+ |
+ ||||
| + |
bucket
string
-
- |
- - | -
- The S3 bucket to store the log in.
- |
+
+
+ + | +
+ The S3 bucket to store the log in.
+ |
||
| - | + | ||||||
| + |
enabled
boolean
-
- |
-
-
|
-
- When enabled=true CloudFront will log access to an S3 bucket.
- |
+
+
+
+
|
+
+ When enabled=true CloudFront will log access to an S3 bucket.
+ |
||
| - | + | ||||||
| + |
include_cookies
boolean
-
- |
-
-
|
-
- When include_cookies=true CloudFront will include cookies in the logs.
- |
+
+
+
+
|
+
+ When include_cookies=true CloudFront will include cookies in the logs.
+ |
||
| - | + | ||||||
| + |
prefix
string
-
- |
- - | -
- A prefix to include in the S3 object names.
- |
- ||||
| + + | ++ | +
+ A prefix to include in the S3 object names.
+ |
+ |||||
|
origins
list
- / elements=dictionary
- |
- - | -
- A config element that is a list of complex origin objects to be specified for the distribution. Used for creating and updating distributions.
- |
- |||||
| - | + / elements=dictionary + | ++ | +
+ A config element that is a list of complex origin objects to be specified for the distribution. Used for creating and updating distributions.
+ |
+ ||||
| + |
custom_headers
list
- / elements=dictionary
- |
- - | -
- Custom headers you wish to add to the request before passing it to the origin.
- For more information see the CloudFront documentation at https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html
- |
- ||||
| - | - | + / elements=dictionary + | ++ | +
+ Custom headers you wish to add to the request before passing it to the origin.
+ For more information see the CloudFront documentation at https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html
+ |
+ |||
| + | + |
header_name
string
-
- |
- - | -
- The name of a header that you want CloudFront to forward to your origin.
- |
+
+
+ + | +
+ The name of a header that you want CloudFront to forward to your origin.
+ |
|
| - | - | + | |||||
| + | + |
header_value
string
-
- |
- - | -
- The value for the header that you specified in the header_name field.
- |
- |||
| - | + + | ++ | +
+ The value for the header that you specified in the header_name field.
+ |
+ ||||
| + |
custom_origin_config
dictionary
-
- |
- - | -
- Connection information about the origin.
- |
- ||||
| - | - | + + | ++ | +
+ Connection information about the origin.
+ |
+ |||
| + | + |
http_port
integer
-
- |
- - | -
- The HTTP port the custom origin listens on.
- |
+
+
+ + | +
+ The HTTP port the custom origin listens on.
+ |
|
| - | - | + | |||||
| + | + |
https_port
integer
-
- |
- - | -
- The HTTPS port the custom origin listens on.
- |
+
+
+ + | +
+ The HTTPS port the custom origin listens on.
+ |
|
| - | - | + | |||||
| + | + |
origin_keepalive_timeout
integer
-
- |
- - | -
- A keep-alive timeout (in seconds).
- |
+
+
+ + | +
+ A keep-alive timeout (in seconds).
+ |
|
| - | - | + | |||||
| + | + |
origin_protocol_policy
string
-
- |
- - | -
- The origin protocol policy to apply to your origin.
- |
+
+
+ + | +
+ The origin protocol policy to apply to your origin.
+ |
|
| - | - | + | |||||
| + | + |
origin_read_timeout
integer
-
- |
- - | -
- A timeout (in seconds) when reading from your origin.
- |
+
+
+ + | +
+ A timeout (in seconds) when reading from your origin.
+ |
|
| - | - | + | |||||
| + | + |
origin_ssl_protocols
list
- / elements=string
- |
- - | -
- A list of SSL/TLS protocols that you want CloudFront to use when communicating to the origin over HTTPS.
- |
- |||
| - | + / elements=string + | ++ | +
+ A list of SSL/TLS protocols that you want CloudFront to use when communicating to the origin over HTTPS.
+ |
+ ||||
| + |
domain_name
string
-
- |
- - | -
- The domain name which CloudFront will query as the origin.
- For more information see the CloudFront documentation at https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesDomainName
- |
+
+
+ + | +
+ The domain name which CloudFront will query as the origin.
+ For more information see the CloudFront documentation at https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesDomainName
+ |
||
| - | + | ||||||
| + |
id
string
-
- |
- - | -
- A unique identifier for the origin or origin group. id must be unique within the distribution.
- |
+
+
+ + | +
+ A unique identifier for the origin or origin group. id must be unique within the distribution.
+ |
||
| - | + | ||||||
| + |
origin_path
string
-
- |
- - | -
- Tells CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin.
- |
+
+
+ + | +
+ Tells CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin.
+ |
||
| - | + | ||||||
| + |
s3_origin_access_identity_enabled
boolean
-
- |
-
-
|
-
- Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront.
- Will automatically create an Identity for you.
-
- |
- ||||
| + + | +
+
|
+
+ Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront.
+ Will automatically create an Identity for you.
+
+ |
+ |||||
|
price_class
string
-
- |
- - | -
- A string that specifies the pricing class of the distribution. As per https://aws.amazon.com/cloudfront/pricing/
- price_class=PriceClass_100 consists of the areas United States, Canada and Europe.
- price_class=PriceClass_200 consists of the areas United States, Canada, Europe, Japan, India, Hong Kong, Philippines, S. Korea, Singapore & Taiwan.
- price_class=PriceClass_All consists of the areas United States, Canada, Europe, Japan, India, South America, Australia, Hong Kong, Philippines, S. Korea, Singapore & Taiwan.
- AWS defaults this to
- PriceClass_All.Valid values are
- PriceClass_100, PriceClass_200 and PriceClass_All |
+
+
+ + | +
+ A string that specifies the pricing class of the distribution. As per https://aws.amazon.com/cloudfront/pricing/
+ price_class=PriceClass_100 consists of the areas United States, Canada and Europe.
+ price_class=PriceClass_200 consists of the areas United States, Canada, Europe, Japan, India, Hong Kong, Philippines, S. Korea, Singapore & Taiwan.
+ price_class=PriceClass_All consists of the areas United States, Canada, Europe, Japan, India, South America, Australia, Hong Kong, Philippines, S. Korea, Singapore & Taiwan.
+ AWS defaults this to
+ PriceClass_All.Valid values are
+ PriceClass_100, PriceClass_200 and PriceClass_All |
|||
| + | |||||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|||
| + | |||||||
|
purge_aliases
boolean
-
- |
-
-
|
-
- Specifies whether existing aliases will be removed before adding new aliases.
- When purge_aliases=yes, existing aliases are removed and aliases are added.
- |
+
+
+
+
|
+
+ Specifies whether existing aliases will be removed before adding new aliases.
+ When purge_aliases=yes, existing aliases are removed and aliases are added.
+ |
|||
| + | |||||||
|
purge_cache_behaviors
boolean
-
- |
-
-
|
-
- Whether to remove any cache behaviors that aren't listed in cache_behaviors.
- This switch also allows the reordering of cache_behaviors.
- |
+
+
+
+
|
+
+ Whether to remove any cache behaviors that aren't listed in cache_behaviors.
+ This switch also allows the reordering of cache_behaviors.
+ |
|||
| + | |||||||
|
purge_custom_error_responses
boolean
-
- |
-
-
|
-
- Whether to remove any custom error responses that aren't listed in custom_error_responses.
- |
+
+
+
+
|
+
+ Whether to remove any custom error responses that aren't listed in custom_error_responses.
+ |
|||
| + | |||||||
|
purge_origins
boolean
-
- |
-
-
|
-
- Whether to remove any origins that aren't listed in origins.
- |
+
+
+
+
|
+
+ Whether to remove any origins that aren't listed in origins.
+ |
|||
| + | |||||||
|
purge_tags
boolean
-
- |
-
-
|
-
- Specifies whether existing tags will be removed before adding new tags.
- When purge_tags=yes, existing tags are removed and tags are added, if specified. If no tags are specified, it removes all existing tags for the distribution.
- When purge_tags=no, existing tags are kept and tags are added, if specified.
- |
- |||||
| + + | +
+
|
+
+ Specifies whether existing tags will be removed before adding new tags.
+ When purge_tags=yes, existing tags are removed and tags are added, if specified. If no tags are specified, it removes all existing tags for the distribution.
+ When purge_tags=no, existing tags are kept and tags are added, if specified.
+ |
+ |||||
|
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 |
+
+
+ + | +
+ 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 |
|||
| + | |||||||
|
restrictions
dictionary
-
- |
- - | -
- A config element that is a complex object that describes how a distribution should restrict it's content.
- |
- |||||
| - | + + | ++ | +
+ A config element that is a complex object that describes how a distribution should restrict it's content.
+ |
+ ||||
| + |
geo_restriction
dictionary
-
- |
- - | -
- Apply a restriciton based on the location of the requester.
- |
- ||||
| - | - | + + | ++ | +
+ Apply a restriction based on the location of the requester.
+ |
+ |||
| + | + |
items
list
-
- |
- - | -
- A list of ISO 3166-1 two letter (Alpha 2) country codes that the restriction should apply to.
- See the ISO website for a full list of codes https://www.iso.org/obp/ui/#search/code/
- |
+
+
+ + | +
+ A list of ISO 3166-1 two letter (Alpha 2) country codes that the restriction should apply to.
+ See the ISO website for a full list of codes https://www.iso.org/obp/ui/#search/code/
+ |
|
| - | - | + | |||||
| + | + |
restriction_type
string
-
- |
- - | -
- The method that you want to use to restrict distribution of your content by country.
- Valid values are
- none, whitelist, blacklist |
- |||
| + + | ++ | +
+ The method that you want to use to restrict distribution of your content by country.
+ Valid values are
+ none, whitelist, blacklist |
+ |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|||
| + | |||||||
|
state
string
-
- |
-
-
|
-
- The desired state of the distribution.
- state=present creates a new distribution or updates an existing distribution.
- state=absent deletes an existing distribution.
- |
- |||||
| + + | +
+
|
+
+ The desired state of the distribution.
+ state=present creates a new distribution or updates an existing distribution.
+ state=absent deletes an existing distribution.
+ |
+ |||||
|
tags
dictionary
-
- |
- - | -
- Should be input as a dict of key-value pairs.
- Note that numeric keys or values must be wrapped in quotes. e.g. "Priority:" '1'
- |
+
+
+ + | +
+ Should be input as a dict of key-value pairs.
+ Note that numeric keys or values must be wrapped in quotes. e.g. "Priority:" '1'
+ |
|||
| + | |||||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
|||
| + | |||||||
|
viewer_certificate
dictionary
-
- |
- - | -
- A dict that specifies the encryption details of the distribution.
- |
- |||||
| - | + + | ++ | +
+ A dict that specifies the encryption details of the distribution.
+ |
+ ||||
| + |
acm_certificate_arn
string
-
- |
- - | -
- The ID of a certificate stored in ACM to use for HTTPS connections.
- If acm_certificate_id is set then you must also specify ssl_support_method
- |
+
+
+ + | +
+ The ID of a certificate stored in ACM to use for HTTPS connections.
+ If acm_certificate_id is set then you must also specify ssl_support_method
+ |
||
| - | + | ||||||
| + |
cloudfront_default_certificate
boolean
-
- |
-
-
|
-
- If you're using the CloudFront domain name for your distribution, such as
- 123456789abcde.cloudfront.net you should set cloudfront_default_certificate=trueIf cloudfront_default_certificate=true do not set ssl_support_method.
- |
- ||||
| - | + + | +
+
|
+
+ If you're using the CloudFront domain name for your distribution, such as
+ 123456789abcde.cloudfront.net you should set cloudfront_default_certificate=trueIf cloudfront_default_certificate=true do not set ssl_support_method.
+ |
+ ||||
| + |
iam_certificate_id
string
-
- |
- - | -
- The ID of a certificate stored in IAM to use for HTTPS connections.
- If iam_certificate_id is set then you must also specify ssl_support_method
- |
+
+
+ + | +
+ The ID of a certificate stored in IAM to use for HTTPS connections.
+ If iam_certificate_id is set then you must also specify ssl_support_method
+ |
||
| - | + | ||||||
| + |
minimum_protocol_version
string
-
- |
- - | -
- The security policy that you want CloudFront to use for HTTPS connections.
- See https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html for supported security policies.
- |
+
+
+ + | +
+ The security policy that you want CloudFront to use for HTTPS connections.
+ See https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html for supported security policies.
+ |
||
| - | + | ||||||
| + |
ssl_support_method
string
-
- |
- - | -
- How CloudFront should serve SSL certificates.
- Valid values are
- sni-only for SNI, and vip if CloudFront is configured to use a dedicated IP for your content. |
- ||||
| + + | ++ | +
+ How CloudFront should serve SSL certificates.
+ Valid values are
+ sni-only for SNI, and vip if CloudFront is configured to use a dedicated IP for your content. |
+ |||||
|
wait
boolean
-
- |
-
-
|
-
- Specifies whether the module waits until the distribution has completed processing the creation or update.
- |
+
+
+
+
|
+
+ Specifies whether the module waits until the distribution has completed processing the creation or update.
+ |
|||
| + | |||||||
|
wait_timeout
integer
-
- |
-
- Default: 1800
- |
-
- Specifies the duration in seconds to wait for a timeout of a cloudfront create or update.
- |
+
+
+
+ Default: 1800
+ |
+
+ Specifies the duration in seconds to wait for a timeout of a cloudfront create or update.
+ |
|||
| + | |||||||
|
web_acl_id
string
-
- |
- - | -
- The ID of a Web Application Firewall (WAF) Access Control List (ACL).
- |
- |||||
| Parameter | Choices/Defaults | -Comments | +Comments |
|---|---|---|---|
| + | |||
|
all_lists
boolean
-
- |
-
-
|
-
- Get all CloudFront lists that do not require parameters.
- |
- |
| + + | +
+
|
+
+ Get all CloudFront lists that do not require parameters.
+ |
+ |
|
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.
- aliases: ec2_access_key, access_key |
- |
| + + | ++ | +
+ 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.
+ aliases: ec2_access_key, access_key |
+ |
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
- |
| + + | ++ | +
+ 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.
- aliases: ec2_secret_key, secret_key |
- |
| + + | ++ | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
+ |
|
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.
- |
- |
| + + | +
+
|
+
+ 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.
+ |
+ |
|
distribution
boolean
-
- |
-
-
|
-
- Get information about a distribution.
- Requires distribution_id or domain_name_alias to be specified.
- |
- |
| + + | +
+
|
+
+ Get information about a distribution.
+ Requires distribution_id or domain_name_alias to be specified.
+ |
+ |
|
distribution_config
boolean
-
- |
-
-
|
-
- Get the configuration information about a distribution.
- Requires distribution_id or domain_name_alias to be specified.
- |
- |
| + + | +
+
|
+
+ Get the configuration information about a distribution.
+ Requires distribution_id or domain_name_alias to be specified.
+ |
+ |
|
distribution_id
string
-
- |
- - | -
- The id of the CloudFront distribution. Used with distribution, distribution_config, invalidation, streaming_distribution, streaming_distribution_config, list_invalidations.
- |
- |
| + + | ++ | +
+ The id of the CloudFront distribution. Used with distribution, distribution_config, invalidation, streaming_distribution, streaming_distribution_config, list_invalidations.
+ |
+ |
|
domain_name_alias
string
-
- |
- - | -
- Can be used instead of distribution_id - uses the aliased CNAME for the CloudFront distribution to get the distribution id where required.
- |
- |
| + + | ++ | +
+ Can be used instead of distribution_id - uses the aliased CNAME for the CloudFront distribution to get the distribution id where required.
+ |
+ |
|
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.
- |
- |
| + + | ++ | +
+ 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 |
+ |
|
invalidation
boolean
-
- |
-
-
|
-
- Get information about an invalidation.
- Requires invalidation_id to be specified.
- |
- |
| + + | +
+
|
+
+ Get information about an invalidation.
+ Requires invalidation_id to be specified.
+ |
+ |
|
invalidation_id
string
-
- |
- - | -
- The id of the invalidation to get information about.
- Used with invalidation.
- |
- |
| + + | ++ | +
+ The id of the invalidation to get information about.
+ Used with invalidation.
+ |
+ |
|
list_distributions
boolean
-
- |
-
-
|
-
- Get a list of CloudFront distributions.
- |
- |
| + + | +
+
|
+
+ Get a list of CloudFront distributions.
+ |
+ |
|
list_distributions_by_web_acl_id
boolean
-
- |
-
-
|
-
- Get a list of distributions using web acl id as a filter.
- Requires web_acl_id to be set.
- |
- |
| + + | +
+
|
+
+ Get a list of distributions using web acl id as a filter.
+ Requires web_acl_id to be set.
+ |
+ |
|
list_invalidations
boolean
-
- |
-
-
|
-
- Get a list of invalidations.
- Requires distribution_id or domain_name_alias to be specified.
- |
- |
| + + | +
+
|
+
+ Get a list of invalidations.
+ Requires distribution_id or domain_name_alias to be specified.
+ |
+ |
|
list_origin_access_identities
boolean
-
- |
-
-
|
-
- Get a list of CloudFront origin access identities.
- Requires origin_access_identity_id to be set.
- |
- |
| + + | +
+
|
+
+ Get a list of CloudFront origin access identities.
+ Requires origin_access_identity_id to be set.
+ |
+ |
|
list_streaming_distributions
boolean
-
- |
-
-
|
-
- Get a list of streaming distributions.
- |
- |
| + + | +
+
|
+
+ Get a list of streaming distributions.
+ |
+ |
|
origin_access_identity
boolean
-
- |
-
-
|
-
- Get information about an origin access identity.
- Requires origin_access_identity_id to be specified.
- |
- |
| + + | +
+
|
+
+ Get information about an origin access identity.
+ Requires origin_access_identity_id to be specified.
+ |
+ |
|
origin_access_identity_config
boolean
-
- |
-
-
|
-
- Get the configuration information about an origin access identity.
- Requires origin_access_identity_id to be specified.
- |
- |
| + + | +
+
|
+
+ Get the configuration information about an origin access identity.
+ Requires origin_access_identity_id to be specified.
+ |
+ |
|
origin_access_identity_id
string
-
- |
- - | -
- The id of the CloudFront origin access identity to get information about.
- |
- |
| + + | ++ | +
+ The id of the CloudFront origin access identity to get information about.
+ |
+ |
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
- |
| + + | ++ | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
+ |
|
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 |
- |
| + + | ++ | +
+ 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 |
+ |
|
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.
- aliases: access_token |
- |
| + + | ++ | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
+ |
|
streaming_distribution
boolean
-
- |
-
-
|
-
- Get information about a specified RTMP distribution.
- Requires distribution_id or domain_name_alias to be specified.
- |
- |
| + + | +
+
|
+
+ Get information about a specified RTMP distribution.
+ Requires distribution_id or domain_name_alias to be specified.
+ |
+ |
|
streaming_distribution_config
boolean
-
- |
-
-
|
-
- Get the configuration information about a specified RTMP distribution.
- Requires distribution_id or domain_name_alias to be specified.
- |
- |
| + + | +
+
|
+
+ Get the configuration information about a specified RTMP distribution.
+ Requires distribution_id or domain_name_alias to be specified.
+ |
+ |
|
summary
boolean
-
- |
-
-
|
-
- Returns a summary of all distributions, streaming distributions and origin_access_identities.
- This is the default behaviour if no option is selected.
- |
- |
| + + | +
+
|
+
+ Returns a summary of all distributions, streaming distributions and origin_access_identities.
+ This is the default behaviour if no option is selected.
+ |
+ |
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
-
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
alias
string
-
- |
- - | -
- The alias of the CloudFront distribution to invalidate paths for. Can be specified instead of distribution_id.
- |
+
+
+ + | +
+ The alias of the CloudFront distribution to invalidate paths for. Can be specified instead of distribution_id.
+ |
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
caller_reference
string
-
- |
-
- Default: null
- |
-
- A unique reference identifier for the invalidation paths.
- Defaults to current datetime stamp.
- |
+
+
+
+ Default: null
+ |
+
+ A unique reference identifier for the invalidation paths.
+ Defaults to current datetime stamp.
+ |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
distribution_id
string
-
- |
- - | -
- The ID of the CloudFront distribution to invalidate paths for. Can be specified instead of the alias.
- |
+
+
+ + | +
+ The ID of the CloudFront distribution to invalidate paths for. Can be specified instead of the alias.
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
target_paths
list
- / elements=string / required
- |
- - | -
- A list of paths on the distribution to invalidate. Each path should begin with '/'. Wildcards are allowed. eg. '/foo/bar/*'
- |
+ / elements=string / required
+
+ + | +
+ A list of paths on the distribution to invalidate. Each path should begin with '/'. Wildcards are allowed. eg. '/foo/bar/*'
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
caller_reference
string
-
- |
- - | -
- A unique identifier to reference the origin access identity by.
- |
+
+
+ + | +
+ A unique identifier to reference the origin access identity by.
+ |
| + | ||||
|
comment
string
-
- |
- - | -
- A comment to describe the CloudFront origin access identity.
- |
+
+
+ + | +
+ A comment to describe the CloudFront origin access identity.
+ |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
origin_access_identity_id
string
-
- |
- - | -
- The origin_access_identity_id of the CloudFront distribution.
- |
+
+
+ + | +
+ The origin_access_identity_id of the CloudFront distribution.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- If the named resource should exist.
- |
+
+
+
+
|
+
+ If the named resource should exist.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
cloudwatch_logs_log_group_arn
string
-
- |
- - | -
- A full ARN specifying a valid CloudWatch log group to which CloudTrail logs will be delivered. The log group should already exist.
-
- Required when
- cloudwatch_logs_role_arn. |
+
+
+ + | +
+ A full ARN specifying a valid CloudWatch log group to which CloudTrail logs will be delivered. The log group should already exist.
+
+ Required when
+ cloudwatch_logs_role_arn. |
| + | ||||
|
cloudwatch_logs_role_arn
string
-
- |
- - | -
- Specifies a full ARN for an IAM role that assigns the proper permissions for CloudTrail to create and write to the log group.
-
- Required when
- cloudwatch_logs_log_group_arn. |
+
+
+ + | +
+ Specifies a full ARN for an IAM role that assigns the proper permissions for CloudTrail to create and write to the log group.
+
+ Required when
+ cloudwatch_logs_log_group_arn. |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
enable_log_file_validation
boolean
-
- |
-
-
|
-
- Specifies whether log file integrity validation is enabled.
- CloudTrail will create a hash for every log file delivered and produce a signed digest file that can be used to ensure log files have not been tampered.
- aliases: log_file_validation_enabled |
+
+
+
+
|
+
+ Specifies whether log file integrity validation is enabled.
+ CloudTrail will create a hash for every log file delivered and produce a signed digest file that can be used to ensure log files have not been tampered.
+ aliases: log_file_validation_enabled |
| + | ||||
|
enable_logging
boolean
-
- |
-
-
|
-
- Start or stop the CloudTrail logging. If stopped the trail will be paused and will not record events or deliver log files.
- |
+
+
+
+
|
+
+ Start or stop the CloudTrail logging. If stopped the trail will be paused and will not record events or deliver log files.
+ |
| + | ||||
|
include_global_events
boolean
-
- |
-
-
|
-
- Record API calls from global services such as IAM and STS.
- aliases: include_global_service_events |
+
+
+
+
|
+
+ Record API calls from global services such as IAM and STS.
+ aliases: include_global_service_events |
| + | ||||
|
is_multi_region_trail
boolean
-
- |
-
-
|
-
- Specify whether the trail belongs only to one region or exists in all regions.
- |
+
+
+
+
|
+
+ Specify whether the trail belongs only to one region or exists in all regions.
+ |
| + | ||||
|
kms_key_id
string
-
- |
- - | -
- Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. This also has the effect of enabling log file encryption.
- The value can be an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.
-
- |
+
+
+ + | +
+ Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. This also has the effect of enabling log file encryption.
+ The value can be an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.
+
+ |
| + | ||||
|
name
string
-
- |
-
- Default: "default"
- |
-
- Name for the CloudTrail.
- Names are unique per-region unless the CloudTrail is a multi-region trail, in which case it is unique per-account.
- |
+
+
+
+ Default: "default"
+ |
+
+ Name for the CloudTrail.
+ Names are unique per-region unless the CloudTrail is a multi-region trail, in which case it is unique per-account.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
s3_bucket_name
string
-
- |
- - | -
- An existing S3 bucket where CloudTrail will deliver log files.
- This bucket should exist and have the proper policy.
-
- Required when state=present.
- |
- ||
| + + | ++ | +
+ An existing S3 bucket where CloudTrail will deliver log files.
+ This bucket should exist and have the proper policy.
+
+ Required when state=present.
+ |
+ ||
|
s3_key_prefix
string
-
- |
- - | -
- S3 Key prefix for delivered log files. A trailing slash is not necessary and will be removed.
- |
+
+
+ + | +
+ S3 Key prefix for delivered log files. A trailing slash is not necessary and will be removed.
+ |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
sns_topic_name
string
-
- |
- - | -
- SNS Topic name to send notifications to when a log file is delivered.
- |
+
+
+ + | +
+ SNS Topic name to send notifications to when a log file is delivered.
+ |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Add or remove CloudTrail configuration.
- The following states have been preserved for backwards compatibility: state=enabled and state=disabled.
- state=enabled is equivalet to state=present.
- state=disabled is equivalet to state=absent.
- |
- ||
| + + | +
+
|
+
+ Add or remove CloudTrail configuration.
+ The following states have been preserved for backwards compatibility: state=enabled and state=disabled.
+ state=enabled is equivalet to state=present.
+ state=disabled is equivalet to state=absent.
+ |
+ ||
|
tags
dictionary
-
- |
-
- Default: {}
- |
-
- A hash/dictionary of tags to be applied to the CloudTrail resource.
- Remove completely or specify an empty dictionary to remove all tags.
- |
+
+
+
+ Default: {}
+ |
+
+ A hash/dictionary of tags to be applied to the CloudTrail resource.
+ Remove completely or specify an empty dictionary to remove all tags.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
-
| Parameter | Choices/Defaults | -Comments | +Comments | |||
|---|---|---|---|---|---|---|
| + | ||||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
||
| + | ||||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
||
| + | ||||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
||
| + | ||||||
|
description
string
-
- |
- - | -
- A description of the rule.
- |
+
+
+ + | +
+ A description of the rule.
+ |
||
| + | ||||||
|
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.
- |
+
+
+ + | +
+ 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 |
||
| + | ||||||
|
event_pattern
string
-
- |
- - | -
- A string pattern (in valid JSON format) that is used to match against incoming events to determine if the rule should be triggered.
- |
+
+
+ + | +
+ A string pattern (in valid JSON format) that is used to match against incoming events to determine if the rule should be triggered.
+ |
||
| + | ||||||
|
name
string
- / required
- |
- - | -
- The name of the rule you are creating, updating or deleting. No spaces or special characters allowed (i.e. must match
- [\.\-_A-Za-z0-9]+). |
+ / required
+
+ + | +
+ The name of the rule you are creating, updating or deleting. No spaces or special characters allowed (i.e. must match
+ [\.\-_A-Za-z0-9]+). |
||
| + | ||||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
||
| + | ||||||
|
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 |
+
+
+ + | +
+ 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 |
||
| + | ||||||
|
role_arn
string
-
- |
- - | -
- The Amazon Resource Name (ARN) of the IAM role associated with the rule.
- |
+
+
+ + | +
+ The Amazon Resource Name (ARN) of the IAM role associated with the rule.
+ |
||
| + | ||||||
|
schedule_expression
string
-
- |
- - | -
- A cron or rate expression that defines the schedule the rule will trigger on. For example,
- cron(0 20 * * ? *), rate(5 minutes). |
+
+
+ + | +
+ A cron or rate expression that defines the schedule the rule will trigger on. For example,
+ cron(0 20 * * ? *), rate(5 minutes). |
||
| + | ||||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
||
| + | ||||||
|
state
string
-
- |
-
-
|
-
- Whether the rule is present (and enabled), disabled, or absent.
- |
+
+
+
+
|
+
+ Whether the rule is present (and enabled), disabled, or absent.
+ |
||
| + | ||||||
|
targets
list
- / elements=dictionary
- |
- - | -
- A list of targets to add to or update for the rule.
- |
+ / elements=dictionary
+
+ + | +
+ A list of targets to add to or update for the rule.
+ |
||
| - | + | |||||
| + |
arn
string
- / required
- |
- - | -
- The ARN associated with the target.
- |
+ / required
+
+ + | +
+ The ARN associated with the target.
+ |
|
| - | + | |||||
| + |
ecs_parameters
dictionary
-
- |
- - | -
- Contains the ECS task definition and task count to be used, if the event target is an ECS task.
- |
+
+
+ + | +
+ Contains the ECS task definition and task count to be used, if the event target is an ECS task.
+ |
|
| - | - | + | ||||
| + | + |
task_count
integer
-
- |
- - | -
- The number of tasks to create based on task_definition.
- |
+
+
+ + | +
+ The number of tasks to create based on task_definition.
+ |
| - | - | + | ||||
| + | + |
task_definition_arn
string
-
- |
- - | -
- The full ARN of the task definition.
- |
+
+
+ + | +
+ The full ARN of the task definition.
+ |
| - | + + | |||||
| + |
id
string
- / required
- |
- - | -
- The unique target assignment ID.
- |
+ / required
+
+ + | +
+ The unique target assignment ID.
+ |
|
| - | + | |||||
| + |
input
string
-
- |
- - | -
- A JSON object that will override the event data when passed to the target.
- If neither input nor input_path is specified, then the entire event is passed to the target in JSON form.
- |
+
+
+ + | +
+ A JSON object that will override the event data when passed to the target.
+ If neither input nor input_path is specified, then the entire event is passed to the target in JSON form.
+ |
|
| - | + | |||||
| + |
input_path
string
-
- |
- - | -
- A JSONPath string (e.g.
- $.detail) that specifies the part of the event data to be passed to the target.If neither input nor input_path is specified, then the entire event is passed to the target in JSON form.
- |
+
+
+ + | +
+ A JSONPath string (e.g.
+ $.detail) that specifies the part of the event data to be passed to the target.If neither input nor input_path is specified, then the entire event is passed to the target in JSON form.
+ |
|
| - | + | |||||
| + |
role_arn
string
-
- |
- - | -
- The ARN of the IAM role to be used for this target when the rule is triggered.
- |
+
+
+ + | +
+ The ARN of the IAM role to be used for this target when the rule is triggered.
+ |
|
| + + | ||||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
||
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
log_group_name
string
-
- |
- - | -
- The name or prefix of the log group to filter by.
- |
+
+
+ + | +
+ The name or prefix of the log group to filter by.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
filter_name
string
- / required
- |
- - | -
- A name for the metric filter you create.
- |
+ / required
+
+ + | +
+ A name for the metric filter you create.
+ |
|
| + | |||||
|
filter_pattern
string
-
- |
- - | -
- A filter pattern for extracting metric data out of ingested log events. Required when state=present.
- |
+
+
+ + | +
+ A filter pattern for extracting metric data out of ingested log events. Required when state=present.
+ |
|
| + | |||||
|
log_group_name
string
- / required
- |
- - | -
- The name of the log group where the metric filter is applied on.
- |
+ / required
+
+ + | +
+ The name of the log group where the metric filter is applied on.
+ |
|
| + | |||||
|
metric_transformation
dictionary
-
- |
- - | -
- A collection of information that defines how metric data gets emitted. Required when state=present.
- |
+
+
+ + | +
+ A collection of information that defines how metric data gets emitted. Required when state=present.
+ |
|
| - | + | ||||
| + |
default_value
float
-
- |
- - | -
- The value to emit when a filter pattern does not match a log event.
- |
+
+
+ + | +
+ The value to emit when a filter pattern does not match a log event.
+ |
| - | + | ||||
| + |
metric_name
string
-
- |
- - | -
- The name of the cloudWatch metric.
- |
+
+
+ + | +
+ The name of the cloudWatch metric.
+ |
| - | + | ||||
| + |
metric_namespace
string
-
- |
- - | -
- The namespace of the cloudWatch metric.
- |
+
+
+ + | +
+ The namespace of the cloudWatch metric.
+ |
| - | + | ||||
| + |
metric_value
string
-
- |
- - | -
- The value to publish to the cloudWatch metric when a filter pattern matches a log event.
- |
+
+
+ + | +
+ The value to publish to the cloudWatch metric when a filter pattern matches a log event.
+ |
| + + | |||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
state
string
- / required
- |
-
-
|
-
- Whether the rule is present or absent.
- |
+ / required
+
+
+
|
+
+ Whether the rule is present or absent.
+ |
|
| + | |||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
|
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
kms_key_id
string
-
- |
- - | -
- The Amazon Resource Name (ARN) of the CMK to use when encrypting log data.
- |
+
+
+ + | +
+ The Amazon Resource Name (ARN) of the CMK to use when encrypting log data.
+ |
| + | ||||
|
log_group_name
string
- / required
- |
- - | -
- The name of the log group.
- |
+ / required
+
+ + | +
+ The name of the log group.
+ |
| + | ||||
|
overwrite
boolean
-
- |
-
-
|
-
- Whether an existing log group should be overwritten on create.
- Mutually exclusive with purge_retention_policy.
- |
+
+
+
+
|
+
+ Whether an existing log group should be overwritten on create.
+ Mutually exclusive with purge_retention_policy.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
purge_retention_policy
boolean
-
- |
-
-
|
-
- Whether to purge the retention policy or not.
- Mutually exclusive with retention and overwrite.
- |
+
+
+
+
|
+
+ Whether to purge the retention policy or not.
+ Mutually exclusive with retention and overwrite.
+ |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
retention
integer
-
- |
- - | -
- The number of days to retain the log events in the specified log group.
- Valid values are: [1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653]
- Mutually exclusive with purge_retention_policy.
- |
+
+
+ + | +
+ The number of days to retain the log events in the specified log group.
+ Valid values are: [1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653]
+ Mutually exclusive with purge_retention_policy.
+ |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Whether the rule is present or absent.
- |
+
+
+
+
|
+
+ Whether the rule is present or absent.
+ |
| + | ||||
|
tags
dictionary
-
- |
- - | -
- The key-value pairs to use for the tags.
- |
+
+
+ + | +
+ The key-value pairs to use for the tags.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |||
|---|---|---|---|---|---|---|
| + | ||||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
||
| + | ||||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
||
| + | ||||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
||
| + | ||||||
|
description
string
-
- |
-
- Default: ""
- |
-
- An optional description for the pipeline being created.
- |
+
+
+
+ Default: ""
+ |
+
+ An optional description for the pipeline being created.
+ |
||
| + | ||||||
|
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.
- |
+
+
+ + | +
+ 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 |
||
| + | ||||||
|
name
string
- / required
- |
- - | -
- The name of the Datapipeline to create/modify/delete.
- |
+ / required
+
+ + | +
+ The name of the Datapipeline to create/modify/delete.
+ |
||
| + | ||||||
|
objects
list
- / elements=dictionary
- |
- - | -
- A list of pipeline object definitions, each of which is a dict that takes the keys id, name and fields.
- |
- ||||
| - | + / elements=dictionary + | ++ | +
+ A list of pipeline object definitions, each of which is a dict that takes the keys id, name and fields.
+ |
+ |||
| + |
fields
list
- / elements=dictionary
- |
- - | -
- Key-value pairs that define the properties of the object.
- The value is specified as a reference to another object refValue or as a string value stringValue but not as both.
- |
- |||
| - | - | + / elements=dictionary + | ++ | +
+ Key-value pairs that define the properties of the object.
+ The value is specified as a reference to another object refValue or as a string value stringValue but not as both.
+ |
+ ||
| + | + |
key
string
-
- |
- - | -
- The field identifier.
- |
+
+
+ + | +
+ The field identifier.
+ |
| - | - | + | ||||
| + | + |
refValue
string
-
- |
- - | -
- The field value, expressed as the identifier of another object.
- Exactly one of stringValue and refValue may be specified.
- |
- ||
| - | - | + + | ++ | +
+ The field value, expressed as the identifier of another object.
+ Exactly one of stringValue and refValue may be specified.
+ |
+ ||
| + | + |
stringValue
string
-
- |
- - | -
- The field value.
- Exactly one of stringValue and refValue may be specified.
- |
- ||
| - | + + | ++ | +
+ The field value.
+ Exactly one of stringValue and refValue may be specified.
+ |
+ |||
| + |
id
string
-
- |
- - | -
- The ID of the object.
- |
+
+
+ + | +
+ The ID of the object.
+ |
|
| - | + | |||||
| + |
name
string
-
- |
- - | -
- The name of the object.
- |
- |||
| + + | ++ | +
+ The name of the object.
+ |
+ ||||
|
parameters
list
- / elements=dictionary
- |
- - | -
- A list of parameter objects (dicts) in the pipeline definition.
- |
- ||||
| - | + / elements=dictionary + | ++ | +
+ A list of parameter objects (dicts) in the pipeline definition.
+ |
+ |||
| + |
attributes
list
- / elements=dictionary
- |
- - | -
- A list of attributes (dicts) of the parameter object.
- |
- |||
| - | - | + / elements=dictionary + | ++ | +
+ A list of attributes (dicts) of the parameter object.
+ |
+ ||
| + | + |
key
string
-
- |
- - | -
- The field identifier.
- |
+
+
+ + | +
+ The field identifier.
+ |
| - | - | + | ||||
| + | + |
stringValue
string
-
- |
- - | -
- The field value.
- |
- ||
| - | + + | ++ | +
+ The field value.
+ |
+ |||
| + |
id
-
-
- |
- - | -
- The ID of the parameter object.
- |
- |||
| + + | ++ | +
+ The ID of the parameter object.
+ |
+ ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
||
| + | ||||||
|
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 |
+
+
+ + | +
+ 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 |
||
| + | ||||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
||
| + | ||||||
|
state
string
-
- |
-
-
|
-
- The requested state of the pipeline.
- |
+
+
+
+
|
+
+ The requested state of the pipeline.
+ |
||
| + | ||||||
|
tags
dictionary
-
- |
- - | -
- A dict of key:value pair(s) to add to the pipeline.
- |
+
+
+ + | +
+ A dict of key:value pair(s) to add to the pipeline.
+ |
||
| + | ||||||
|
timeout
integer
-
- |
-
- Default: 300
- |
-
- Time in seconds to wait for the pipeline to transition to the requested state, fail otherwise.
- |
+
+
+
+ Default: 300
+ |
+
+ Time in seconds to wait for the pipeline to transition to the requested state, fail otherwise.
+ |
||
| + | ||||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
||
| + | ||||||
|
values
list
- / elements=dictionary
- |
- - | -
- A list of parameter values (dicts) in the pipeline definition.
- |
- ||||
| - | + / elements=dictionary + | ++ | +
+ A list of parameter values (dicts) in the pipeline definition.
+ |
+ |||
| + |
id
string
-
- |
- - | -
- The ID of the parameter value
- |
+
+
+ + | +
+ The ID of the parameter value
+ |
|
| - | + | |||||
| + |
stringValue
string
-
- |
- - | -
- The field value
- |
- |||
| + + | ++ | +
+ The field value
+ |
+ ||||
|
version
string
-
- |
- - | -
- The version option has never had any effect and will be removed after 2022-06-01.
- |
- ||||
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
- ||
| + + | ++ | +
+ 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.
+ aliases: ec2_access_key, access_key |
+ ||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
- ||
| + + | ++ | +
+ 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.
- aliases: ec2_secret_key, secret_key |
- ||
| + + | ++ | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
+ ||
|
certificatearn
string
-
- |
- - | -
- Amazon Resource Name (ARN) for the certificate.
- |
+
+
+ + | +
+ Amazon Resource Name (ARN) for the certificate.
+ |
| + | ||||
|
databasename
string
-
- |
- - | -
- Name for the database on the origin or target side.
- |
+
+
+ + | +
+ Name for the database on the origin or target side.
+ |
| + | ||||
|
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.
- |
- ||
| + + | +
+
|
+
+ 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.
+ |
+ ||
|
dmstransfersettings
dictionary
-
- |
- - | -
- The settings in JSON format for the DMS transfer type of source endpoint.
- |
+
+
+ + | +
+ The settings in JSON format for the DMS transfer type of source endpoint.
+ |
| + | ||||
|
dynamodbsettings
dictionary
-
- |
- - | -
- Settings in JSON format for the target Amazon DynamoDB endpoint if source or target is dynamodb.
- |
+
+
+ + | +
+ Settings in JSON format for the target Amazon DynamoDB endpoint if source or target is dynamodb.
+ |
| + | ||||
|
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.
- |
- ||
| + + | ++ | +
+ 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 |
+ ||
|
elasticsearchsettings
dictionary
-
- |
- - | -
- Settings in JSON format for the target Elasticsearch endpoint.
- |
+
+
+ + | +
+ Settings in JSON format for the target Elasticsearch endpoint.
+ |
| + | ||||
|
endpointidentifier
string
- / required
- |
- - | -
- An identifier name for the endpoint.
- |
+ / required
+
+ + | +
+ An identifier name for the endpoint.
+ |
| + | ||||
|
endpointtype
string
- / required
- |
-
-
|
-
- Type of endpoint we want to manage.
- |
- ||
| + / required + | +
+
|
+
+ Type of endpoint we want to manage.
+ |
+ ||
|
enginename
string
- / required
- |
-
-
|
-
- Database engine that we want to use, please refer to the AWS DMS for more information on the supported engines and their limitations.
- |
- ||
| + / required + | +
+
|
+
+ Database engine that we want to use, please refer to the AWS DMS for more information on the supported engines and their limitations.
+ |
+ ||
|
externaltabledefinition
string
-
- |
- - | -
- The external table definition.
- |
+
+
+ + | +
+ The external table definition.
+ |
| + | ||||
|
extraconnectionattributes
string
-
- |
- - | -
- Extra attributes for the database connection, the AWS documentation states " For more information about extra connection attributes, see the documentation section for your data store."
- |
+
+
+ + | +
+ Extra attributes for the database connection, the AWS documentation states " For more information about extra connection attributes, see the documentation section for your data store."
+ |
| + | ||||
|
kinesissettings
dictionary
-
- |
- - | -
- Settings in JSON format for the target Amazon Kinesis Data Streams endpoint.
- |
+
+
+ + | +
+ Settings in JSON format for the target Amazon Kinesis Data Streams endpoint.
+ |
| + | ||||
|
kmskeyid
string
-
- |
- - | -
- Encryption key to use to encrypt replication storage and connection information.
- |
+
+
+ + | +
+ Encryption key to use to encrypt replication storage and connection information.
+ |
| + | ||||
|
mongodbsettings
dictionary
-
- |
- - | -
- Settings in JSON format for the source MongoDB endpoint.
- |
+
+
+ + | +
+ Settings in JSON format for the source MongoDB endpoint.
+ |
| + | ||||
|
password
string
-
- |
- - | -
- Password used to connect to the database this attribute can only be written the AWS API does not return this parameter.
- |
+
+
+ + | +
+ Password used to connect to the database this attribute can only be written the AWS API does not return this parameter.
+ |
| + | ||||
|
port
integer
-
- |
- - | -
- TCP port for access to the database.
- |
+
+
+ + | +
+ TCP port for access to the database.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
- ||
| + + | ++ | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
+ ||
|
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 |
- ||
| + + | ++ | +
+ 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 |
+ ||
|
retries
integer
-
- |
- - | -
- number of times we should retry when deleting a resource
- Required when wait=true.
- |
- ||
| + + | ++ | +
+ number of times we should retry when deleting a resource
+ Required when wait=true.
+ |
+ ||
|
s3settings
dictionary
-
- |
- - | -
- S3 buckets settings for the target Amazon S3 endpoint.
- |
+
+
+ + | +
+ S3 buckets settings for the target Amazon S3 endpoint.
+ |
| + | ||||
|
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.
- aliases: access_token |
- ||
| + + | ++ | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
+ ||
|
servername
string
-
- |
- - | -
- Servername that the endpoint will connect to.
- |
+
+
+ + | +
+ Servername that the endpoint will connect to.
+ |
| + | ||||
|
serviceaccessrolearn
string
-
- |
- - | -
- Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
- |
+
+
+ + | +
+ Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
+ |
| + | ||||
|
sslmode
string
-
- |
-
-
|
-
- Mode used for the SSL connection.
- |
- ||
| + + | +
+
|
+
+ Mode used for the SSL connection.
+ |
+ ||
|
state
string
-
- |
-
-
|
-
- State of the endpoint.
- |
- ||
| + + | +
+
|
+
+ State of the endpoint.
+ |
+ ||
|
tags
dictionary
-
- |
- - | -
- A list of tags to add to the endpoint.
- |
+
+
+ + | +
+ A list of tags to add to the endpoint.
+ |
| + | ||||
|
timeout
integer
-
- |
- - | -
- Time in seconds we should wait for when deleting a resource.
- Required when wait=true.
- |
- ||
| + + | ++ | +
+ Time in seconds we should wait for when deleting a resource.
+ Required when wait=true.
+ |
+ ||
|
username
string
-
- |
- - | -
- Username our endpoint will use to connect to the database.
- |
+
+
+ + | +
+ Username our endpoint will use to connect to the database.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
- ||
| + + | +
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
+ ||
|
wait
boolean
-
- |
-
-
|
-
- Whether Ansible should wait for the object to be deleted when state=absent.
- |
-
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
description
string
- / required
- |
- - | -
- The description for the subnet group.
- |
+ / required
+
+ + | +
+ The description for the subnet group.
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
identifier
string
- / required
- |
- - | -
- The name for the replication subnet group. This value is stored as a lowercase string. Must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens. Must not be "default".
- |
+ / required
+
+ + | +
+ The name for the replication subnet group. This value is stored as a lowercase string. Must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens. Must not be "default".
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- State of the subnet group.
- |
+
+
+
+
|
+
+ State of the subnet group.
+ |
| + | ||||
|
subnet_ids
list
- / elements=string / required
- |
- - | -
- A list containing the subnet ids for the replication subnet group, needs to be at least 2 items in the list.
- |
+ / elements=string / required
+
+ + | +
+ A list containing the subnet ids for the replication subnet group, needs to be at least 2 items in the list.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
hash_key_name
string
-
- |
- - | -
- Name of the hash key.
- Required when
- state=present. |
+
+
+ + | +
+ Name of the hash key.
+ Required when
+ state=present. |
|
| + | |||||
|
hash_key_type
string
-
- |
-
-
|
-
- Type of the hash key.
- |
+
+
+
+
|
+
+ Type of the hash key.
+ |
|
| + | |||||
|
indexes
list
- / elements=dictionary
- |
-
- Default: []
- |
-
- list of dictionaries describing indexes to add to the table. global indexes can be updated. local indexes don't support updates or have throughput.
- required options: ['name', 'type', 'hash_key_name']
- other options: ['hash_key_type', 'range_key_name', 'range_key_type', 'includes', 'read_capacity', 'write_capacity']
- |
+ / elements=dictionary
+
+
+ Default: []
+ |
+
+ list of dictionaries describing indexes to add to the table. global indexes can be updated. local indexes don't support updates or have throughput.
+ required options: ['name', 'type', 'hash_key_name']
+ other options: ['hash_key_type', 'range_key_name', 'range_key_type', 'includes', 'read_capacity', 'write_capacity']
+ |
|
| - | + | ||||
| + |
hash_key_name
string
- / required
- |
- - | -
- The name of the hash-based key.
- |
+ / required
+
+ + | +
+ The name of the hash-based key.
+ |
| - | + | ||||
| + |
hash_key_type
string
-
- |
- - | -
- The type of the hash-based key.
- |
+
+
+ + | +
+ The type of the hash-based key.
+ |
| - | + | ||||
| + |
includes
list
-
- |
- - | -
- A list of fields to include when using
- global_include or include indexes. |
+
+
+ + | +
+ A list of fields to include when using
+ global_include or include indexes. |
| - | + | ||||
| + |
name
string
- / required
- |
- - | -
- The name of the index.
- |
+ / required
+
+ + | +
+ The name of the index.
+ |
| - | + | ||||
| + |
range_key_name
string
-
- |
- - | -
- The name of the range-based key.
- |
+
+
+ + | +
+ The name of the range-based key.
+ |
| - | + | ||||
| + |
range_key_type
string
-
- |
- - | -
- The type of the range-based key.
- |
+
+
+ + | +
+ The type of the range-based key.
+ |
| - | + | ||||
| + |
read_capacity
integer
-
- |
- - | -
- Read throughput capacity (units) to provision for the index.
- |
+
+
+ + | +
+ Read throughput capacity (units) to provision for the index.
+ |
| - | + | ||||
| + |
type
string
- / required
- |
- - | -
- The type of index.
- Valid types:
- all, global_all, global_include, global_keys_only, include, keys_only |
+ / required
+
+ + | +
+ The type of index.
+ Valid types:
+ all, global_all, global_include, global_keys_only, include, keys_only |
| - | + | ||||
| + |
write_capacity
integer
-
- |
- - | -
- Write throughput capacity (units) to provision for the index.
- |
+
+
+ + | +
+ Write throughput capacity (units) to provision for the index.
+ |
| + + | |||||
|
name
string
- / required
- |
- - | -
- Name of the table.
- |
+ / required
+
+ + | +
+ Name of the table.
+ |
|
| + | |||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
range_key_name
string
-
- |
- - | -
- Name of the range key.
- |
+
+
+ + | +
+ Name of the range key.
+ |
|
| + | |||||
|
range_key_type
string
-
- |
-
-
|
-
- Type of the range key.
- |
+
+
+
+
|
+
+ Type of the range key.
+ |
|
| + | |||||
|
read_capacity
integer
-
- |
-
- Default: 1
- |
-
- Read throughput capacity (units) to provision.
- |
+
+
+
+ Default: 1
+ |
+
+ Read throughput capacity (units) to provision.
+ |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
state
string
-
- |
-
-
|
-
- Create or delete the table.
- |
+
+
+
+
|
+
+ Create or delete the table.
+ |
|
| + | |||||
|
tags
dictionary
-
- |
- - | -
- A hash/dictionary of tags to add to the new instance or for starting/stopping instance by tag.
- For example:
- {"key":"value"} and {"key":"value","key2":"value2"} |
+
+
+ + | +
+ A hash/dictionary of tags to add to the new instance or for starting/stopping instance by tag.
+ For example:
+ {"key":"value"} and {"key":"value","key2":"value2"} |
|
| + | |||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
|
| + | |||||
|
wait_for_active_timeout
integer
-
- |
-
- Default: 60
- |
-
- how long before wait gives up, in seconds. only used when tags is set
- |
+
+
+
+ Default: 60
+ |
+
+ how long before wait gives up, in seconds. only used when tags is set
+ |
|
| + | |||||
|
write_capacity
integer
-
- |
-
- Default: 1
- |
-
- Write throughput capacity (units) to provision.
- |
+
+
+
+ Default: 1
+ |
+
+ Write throughput capacity (units) to provision.
+ |
|
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
attribute_name
string
- / required
- |
- - | -
- The name of the Time To Live attribute used to store the expiration time for items in the table.
- This appears to be required by the API even when disabling TTL.
- |
+ / required
+
+ + | +
+ The name of the Time To Live attribute used to store the expiration time for items in the table.
+ This appears to be required by the API even when disabling TTL.
+ |
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- State to set DynamoDB table to.
- |
+
+
+
+
|
+
+ State to set DynamoDB table to.
+ |
| + | ||||
|
table_name
string
- / required
- |
- - | -
- Name of the DynamoDB table to work on.
- |
+ / required
+
+ + | +
+ Name of the DynamoDB table to work on.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
description
string
-
- |
- - | -
- An optional human-readable string describing the contents and purpose of the new AMI.
- |
+
+
+ + | +
+ An optional human-readable string describing the contents and purpose of the new AMI.
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
encrypted
boolean
-
- |
-
-
|
-
- Whether or not the destination snapshots of the copied AMI should be encrypted.
- |
+
+
+
+
|
+
+ Whether or not the destination snapshots of the copied AMI should be encrypted.
+ |
| + | ||||
|
kms_key_id
string
-
- |
- - | -
- KMS key id used to encrypt the image. If not specified, uses default EBS Customer Master Key (CMK) for your account.
- |
+
+
+ + | +
+ KMS key id used to encrypt the image. If not specified, uses default EBS Customer Master Key (CMK) for your account.
+ |
| + | ||||
|
name
string
-
- |
-
- Default: "default"
- |
-
- The name of the new AMI to copy. (As of 2.3 the default is 'default', in prior versions it was 'null'.)
- |
+
+
+
+ Default: "default"
+ |
+
+ The name of the new AMI to copy. (As of 2.3 the default is 'default', in prior versions it was 'null'.)
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
source_image_id
string
- / required
- |
- - | -
- The ID of the AMI in source region that should be copied.
- |
+ / required
+
+ + | +
+ The ID of the AMI in source region that should be copied.
+ |
| + | ||||
|
source_region
string
- / required
- |
- - | -
- The source region the AMI should be copied from.
- |
+ / required
+
+ + | +
+ The source region the AMI should be copied from.
+ |
| + | ||||
|
tag_equality
boolean
-
- |
-
-
|
-
- Whether to use tags if the source AMI already exists in the target region. If this is set, and all tags match in an existing AMI, the AMI will not be copied again.
- |
+
+
+
+
|
+
+ Whether to use tags if the source AMI already exists in the target region. If this is set, and all tags match in an existing AMI, the AMI will not be copied again.
+ |
| + | ||||
|
tags
dictionary
-
- |
- - | -
- A hash/dictionary of tags to add to the new copied AMI:
- {"key":"value"} and {"key":"value","key":"value"} |
+
+
+ + | +
+ A hash/dictionary of tags to add to the new copied AMI:
+ {"key":"value"} and {"key":"value","key":"value"} |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
wait
boolean
-
- |
-
-
|
-
- Wait for the copied AMI to be in state 'available' before returning.
- |
+
+
+
+
|
+
+ Wait for the copied AMI to be in state 'available' before returning.
+ |
| + | ||||
|
wait_timeout
integer
-
- |
-
- Default: 600
- |
-
- How long before wait gives up, in seconds. Prior to 2.3 the default was 1200.
- From 2.3-2.5 this option was deprecated in favor of boto3 waiter defaults. This was reenabled in 2.6 to allow timeouts greater than 10 minutes.
- |
+
+
+
+ Default: 600
+ |
+
+ How long before wait gives up, in seconds. Prior to 2.3 the default was 1200.
+ From 2.3-2.5 this option was deprecated in favor of boto3 waiter defaults. This was reenabled in 2.6 to allow timeouts greater than 10 minutes.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments |
|---|---|---|---|
| + | |||
|
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.
- aliases: ec2_access_key, access_key |
- |
| + + | ++ | +
+ 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.
+ aliases: ec2_access_key, access_key |
+ |
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
- |
| + + | ++ | +
+ 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.
- aliases: ec2_secret_key, secret_key |
- |
| + + | ++ | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
+ |
|
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.
- |
- |
| + + | +
+
|
+
+ 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.
- |
- |
| + + | ++ | +
+ 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 |
+ |
|
name
string
-
- |
- - | -
- The prefix or name of the auto scaling group(s) you are searching for.
- Note: This is a regular expression match with implicit '^' (beginning of string). Append '$' for a complete name match.
- |
- |
| + + | ++ | +
+ The prefix or name of the auto scaling group(s) you are searching for.
+ Note: This is a regular expression match with implicit '^' (beginning of string). Append '$' for a complete name match.
+ |
+ |
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
- |
| + + | ++ | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
+ |
|
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 |
- |
| + + | ++ | +
+ 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 |
+ |
|
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.
- aliases: access_token |
- |
| + + | ++ | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
+ |
|
tags
dictionary
-
- |
- - | -
- A dictionary/hash of tags in the format { tag1_name: 'tag1_value', tag2_name: 'tag2_value' } to match against the auto scaling group(s) you are searching for.
- |
- |
| + + | ++ | +
+ A dictionary/hash of tags in the format { tag1_name: 'tag1_value', tag2_name: 'tag2_value' } to match against the auto scaling group(s) you are searching for.
+ |
+ |
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
-
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
autoscaling_group_name
string
- / required
- |
- - | -
- The name of the Auto Scaling group to which you want to assign the lifecycle hook.
- |
+ / required
+
+ + | +
+ The name of the Auto Scaling group to which you want to assign the lifecycle hook.
+ |
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
default_result
string
-
- |
-
-
|
-
- Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs.
- |
+
+
+
+
|
+
+ Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs.
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
heartbeat_timeout
integer
-
- |
- - | -
- The amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.
- By default Amazon AWS will use 3600 (1 hour)
- |
+
+
+ + | +
+ The amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.
+ By default Amazon AWS will use 3600 (1 hour)
+ |
| + | ||||
|
lifecycle_hook_name
string
- / required
- |
- - | -
- The name of the lifecycle hook.
- |
+ / required
+
+ + | +
+ The name of the lifecycle hook.
+ |
| + | ||||
|
notification_meta_data
string
-
- |
- - | -
- Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.
- |
+
+
+ + | +
+ Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.
+ |
| + | ||||
|
notification_target_arn
string
-
- |
- - | -
- The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook.
- This target can be either an SQS queue or an SNS topic.
- If you specify an empty string, this overrides the current ARN.
- |
+
+
+ + | +
+ The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook.
+ This target can be either an SQS queue or an SNS topic.
+ If you specify an empty string, this overrides the current ARN.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
role_arn
string
-
- |
- - | -
- The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
- |
+
+
+ + | +
+ The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
+ |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Create or delete Lifecycle Hook.
- When state=present updates existing hook or creates a new hook if not found.
- |
+
+
+
+
|
+
+ Create or delete Lifecycle Hook.
+ When state=present updates existing hook or creates a new hook if not found.
+ |
| + | ||||
|
transition
string
-
- |
-
-
|
-
- The instance state to which you want to attach the lifecycle hook.
- Required when state=present.
- |
+
+
+
+
|
+
+ The instance state to which you want to attach the lifecycle hook.
+ Required when state=present.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
availability_zones
list
- / elements=string
- |
- - | -
- List of availability zone names in which to create the group.
- Defaults to all the availability zones in the region if vpc_zone_identifier is not set.
- |
+ / elements=string
+
+ + | +
+ List of availability zone names in which to create the group.
+ Defaults to all the availability zones in the region if vpc_zone_identifier is not set.
+ |
|
| + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
|
| + | |||||
|
default_cooldown
integer
-
- |
-
- Default: 300
- |
-
- The number of seconds after a scaling activity completes before another can begin.
- |
+
+
+
+ Default: 300
+ |
+
+ The number of seconds after a scaling activity completes before another can begin.
+ |
|
| + | |||||
|
desired_capacity
integer
-
- |
- - | -
- Desired number of instances in group, if unspecified then the current group value will be used.
- |
+
+
+ + | +
+ Desired number of instances in group, if unspecified then the current group value will 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.
- |
+
+
+ + | +
+ 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_period
integer
-
- |
-
- Default: 300
- |
-
- Length of time in seconds after a new EC2 instance comes into service that Auto Scaling starts checking its health.
- |
+
+
+
+ Default: 300
+ |
+
+ Length of time in seconds after a new EC2 instance comes into service that Auto Scaling starts checking its health.
+ |
|
| + | |||||
|
health_check_type
string
-
- |
-
-
|
-
- The service you want the health status from, Amazon EC2 or Elastic Load Balancer.
- |
+
+
+
+
|
+
+ The service you want the health status from, Amazon EC2 or Elastic Load Balancer.
+ |
|
| + | |||||
|
launch_config_name
string
-
- |
- - | -
- Name of the Launch configuration to use for the group. See the community.aws.ec2_lc) module for managing these.
- If unspecified then the current group value will be used. One of launch_config_name or launch_template must be provided.
- |
+
+
+ + | +
+ Name of the Launch configuration to use for the group. See the community.aws.ec2_lc) module for managing these.
+ If unspecified then the current group value will be used. One of launch_config_name or launch_template must be provided.
+ |
|
| + | |||||
|
launch_template
dictionary
-
- |
- - | -
- Dictionary describing the Launch Template to use
- |
- |||
| - | + + | ++ | +
+ Dictionary describing the Launch Template to use
+ |
+ ||
| + |
launch_template_id
string
-
- |
- - | -
- The id of the launch template. Only one of launch_template_name or launch_template_id is required.
- |
+
+
+ + | +
+ The id of the launch template. Only one of launch_template_name or launch_template_id is required.
+ |
| - | + | ||||
| + |
launch_template_name
string
-
- |
- - | -
- The name of the launch template. Only one of launch_template_name or launch_template_id is required.
- |
+
+
+ + | +
+ The name of the launch template. Only one of launch_template_name or launch_template_id is required.
+ |
| - | + | ||||
| + |
version
string
-
- |
- - | -
- The version number of the launch template to use.
- Defaults to latest version if not provided.
- |
- ||
| + + | ++ | +
+ The version number of the launch template to use.
+ Defaults to latest version if not provided.
+ |
+ |||
|
lc_check
boolean
-
- |
-
-
|
-
- Check to make sure instances that are being replaced with replace_instances do not already have the current launch_config.
- |
+
+
+
+
|
+
+ Check to make sure instances that are being replaced with replace_instances do not already have the current launch_config.
+ |
|
| + | |||||
|
load_balancers
list
- / elements=string
- |
- - | -
- List of ELB names to use for the group. Use for classic load balancers.
- |
+ / elements=string
+
+ + | +
+ List of ELB names to use for the group. Use for classic load balancers.
+ |
|
| + | |||||
|
lt_check
boolean
-
- |
-
-
|
-
- Check to make sure instances that are being replaced with replace_instances do not already have the current launch_template or I(launch_template version.
- |
+
+
+
+
|
+
+ Check to make sure instances that are being replaced with replace_instances do not already have the current launch_template or I(launch_template version.
+ |
|
| + | |||||
|
max_instance_lifetime
integer
-
- |
- - | -
- The maximum amount of time, in seconds, that an instance can be in service.
- Maximum instance lifetime must be equal to 0, between 604800 and 31536000 seconds (inclusive), or not specified.
- Value of 0 removes lifetime restriction.
- |
+
+
+ + | +
+ The maximum amount of time, in seconds, that an instance can be in service.
+ Maximum instance lifetime must be equal to 0, between 604800 and 31536000 seconds (inclusive), or not specified.
+ Value of 0 removes lifetime restriction.
+ |
|
| + | |||||
|
max_size
integer
-
- |
- - | -
- Maximum number of instances in group, if unspecified then the current group value will be used.
- |
+
+
+ + | +
+ Maximum number of instances in group, if unspecified then the current group value will be used.
+ |
|
| + | |||||
|
metrics_collection
boolean
-
- |
-
-
|
-
- Enable ASG metrics collection.
- |
+
+
+
+
|
+
+ Enable ASG metrics collection.
+ |
|
| + | |||||
|
metrics_granularity
string
-
- |
-
- Default: "1Minute"
- |
-
- When metrics_collection=true this will determine the granularity of metrics collected by CloudWatch.
- |
+
+
+
+ Default: "1Minute"
+ |
+
+ When metrics_collection=true this will determine the granularity of metrics collected by CloudWatch.
+ |
|
| + | |||||
|
metrics_list
list
- / elements=string
- |
-
- Default: ["GroupMinSize", "GroupMaxSize", "GroupDesiredCapacity", "GroupInServiceInstances", "GroupPendingInstances", "GroupStandbyInstances", "GroupTerminatingInstances", "GroupTotalInstances"]
- |
-
- List of autoscaling metrics to collect when metrics_collection=true.
- |
+ / elements=string
+
+
+ Default: ["GroupMinSize", "GroupMaxSize", "GroupDesiredCapacity", "GroupInServiceInstances", "GroupPendingInstances", "GroupStandbyInstances", "GroupTerminatingInstances", "GroupTotalInstances"]
+ |
+
+ List of autoscaling metrics to collect when metrics_collection=true.
+ |
|
| + | |||||
|
min_size
integer
-
- |
- - | -
- Minimum number of instances in group, if unspecified then the current group value will be used.
- |
+
+
+ + | +
+ Minimum number of instances in group, if unspecified then the current group value will be used.
+ |
|
| + | |||||
|
mixed_instances_policy
dictionary
-
- |
- - | -
- A mixed instance policy to use for the ASG.
- Only used when the ASG is configured to use a Launch Template (launch_template).
-
- |
- |||
| - | + + | ++ | +
+ A mixed instance policy to use for the ASG.
+ Only used when the ASG is configured to use a Launch Template (launch_template).
+
+ |
+ ||
| + |
instance_types
list
- / elements=string
- |
- - | -
- A list of instance_types.
- |
- ||
| + / elements=string + | ++ | +
+ A list of instance_types.
+ |
+ |||
|
name
string
- / required
- |
- - | -
- Unique name for group to be created or deleted.
- |
+ / required
+
+ + | +
+ Unique name for group to be created or deleted.
+ |
|
| + | |||||
|
notification_topic
string
-
- |
- - | -
- A SNS topic ARN to send auto scaling notifications to.
- |
+
+
+ + | +
+ A SNS topic ARN to send auto scaling notifications to.
+ |
|
| + | |||||
|
notification_types
list
- / elements=string
- |
-
- Default: ["autoscaling:EC2_INSTANCE_LAUNCH", "autoscaling:EC2_INSTANCE_LAUNCH_ERROR", "autoscaling:EC2_INSTANCE_TERMINATE", "autoscaling:EC2_INSTANCE_TERMINATE_ERROR"]
- |
-
- A list of auto scaling events to trigger notifications on.
- |
+ / elements=string
+
+
+ Default: ["autoscaling:EC2_INSTANCE_LAUNCH", "autoscaling:EC2_INSTANCE_LAUNCH_ERROR", "autoscaling:EC2_INSTANCE_TERMINATE", "autoscaling:EC2_INSTANCE_TERMINATE_ERROR"]
+ |
+
+ A list of auto scaling events to trigger notifications on.
+ |
|
| + | |||||
|
placement_group
string
-
- |
- - | -
- Physical location of your cluster placement group created in Amazon EC2.
- |
+
+
+ + | +
+ Physical location of your cluster placement group created in Amazon EC2.
+ |
|
| + | |||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
replace_all_instances
boolean
-
- |
-
-
|
-
- In a rolling fashion, replace all instances that used the old launch configuration with one from the new launch configuration. It increases the ASG size by replace_batch_size, waits for the new instances to be up and running. After that, it terminates a batch of old instances, waits for the replacements, and repeats, until all old instances are replaced. Once that's done the ASG size is reduced back to the expected size.
- |
+
+
+
+
|
+
+ In a rolling fashion, replace all instances that used the old launch configuration with one from the new launch configuration. It increases the ASG size by replace_batch_size, waits for the new instances to be up and running. After that, it terminates a batch of old instances, waits for the replacements, and repeats, until all old instances are replaced. Once that's done the ASG size is reduced back to the expected size.
+ |
|
| + | |||||
|
replace_batch_size
integer
-
- |
-
- Default: 1
- |
-
- Number of instances you'd like to replace at a time. Used with replace_all_instances.
- |
+
+
+
+ Default: 1
+ |
+
+ Number of instances you'd like to replace at a time. Used with replace_all_instances.
+ |
|
| + | |||||
|
replace_instances
list
- / elements=string
- |
- - | -
- List of instance_ids belonging to the named AutoScalingGroup that you would like to terminate and be replaced with instances matching the current launch configuration.
- |
+ / elements=string
+
+ + | +
+ List of instance_ids belonging to the named AutoScalingGroup that you would like to terminate and be replaced with instances matching the current launch configuration.
+ |
|
| + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
state
string
-
- |
-
-
|
-
- Register or deregister the instance.
- |
+
+
+
+
|
+
+ Register or deregister the instance.
+ |
|
| + | |||||
|
suspend_processes
list
- / elements=string
- |
-
- Default: []
- |
-
- A list of scaling processes to suspend.
- Valid values include:
- Launch, Terminate, HealthCheck, ReplaceUnhealthy, AZRebalance, AlarmNotification, ScheduledActions, AddToLoadBalancerFull documentation of valid values can be found in the AWS documentation:
-
- |
- |||
| + / elements=string + | +
+ Default: []
+ |
+
+ A list of scaling processes to suspend.
+ Valid values include:
+ Launch, Terminate, HealthCheck, ReplaceUnhealthy, AZRebalance, AlarmNotification, ScheduledActions, AddToLoadBalancerFull documentation of valid values can be found in the AWS documentation:
+
+ |
+ |||
|
tags
list
- / elements=dictionary
- |
- - | -
- A list of tags to add to the Auto Scale Group.
- Optional key is propagate_at_launch, which defaults to true.
- When propagate_at_launch is true the tags will be propagated to the Instances created.
- |
+ / elements=dictionary
+
+ + | +
+ A list of tags to add to the Auto Scale Group.
+ Optional key is propagate_at_launch, which defaults to true.
+ When propagate_at_launch is true the tags will be propagated to the Instances created.
+ |
|
| + | |||||
|
target_group_arns
list
- / elements=string
- |
- - | -
- List of target group ARNs to use for the group. Use for application load balancers.
- |
+ / elements=string
+
+ + | +
+ List of target group ARNs to use for the group. Use for application load balancers.
+ |
|
| + | |||||
|
termination_policies
list
- / elements=string
- |
-
- Default: "Default"
- |
-
- An ordered list of criteria used for selecting instances to be removed from the Auto Scaling group when reducing capacity.
- Using termination_policies=Default when modifying an existing AutoScalingGroup will result in the existing policy being retained instead of changed to
- Default.Valid values include:
- Default, OldestInstance, NewestInstance, OldestLaunchConfiguration, ClosestToNextInstanceHourFull documentation of valid values can be found in the AWS documentation:
-
- |
- |||
| + / elements=string + | +
+ Default: "Default"
+ |
+
+ An ordered list of criteria used for selecting instances to be removed from the Auto Scaling group when reducing capacity.
+ Using termination_policies=Default when modifying an existing AutoScalingGroup will result in the existing policy being retained instead of changed to
+ Default.Valid values include:
+ Default, OldestInstance, NewestInstance, OldestLaunchConfiguration, ClosestToNextInstanceHourFull documentation of valid values can be found in the AWS documentation:
+
+ |
+ |||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
|
| + | |||||
|
vpc_zone_identifier
list
- / elements=string
- |
- - | -
- List of VPC subnets to use
- |
+ / elements=string
+
+ + | +
+ List of VPC subnets to use
+ |
|
| + | |||||
|
wait_for_instances
boolean
-
- |
-
-
|
-
- Wait for the ASG instances to be in a ready state before exiting. If instances are behind an ELB, it will wait until the ELB determines all instances have a lifecycle_state of "InService" and a health_status of "Healthy".
- |
+
+
+
+
|
+
+ Wait for the ASG instances to be in a ready state before exiting. If instances are behind an ELB, it will wait until the ELB determines all instances have a lifecycle_state of "InService" and a health_status of "Healthy".
+ |
|
| + | |||||
|
wait_timeout
integer
-
- |
-
- Default: 300
- |
-
- How long to wait for instances to become viable when replaced. If you experience the error "Waited too long for ELB instances to be healthy", try increasing this value.
- |
- |||
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
customer_gateway_ids
list
- / elements=string
- |
- - | -
- Get details of a specific customer gateways using customer gateway ID/IDs. This value should be provided as a list.
- |
+ / elements=string
+
+ + | +
+ Get details of a specific customer gateways using customer gateway ID/IDs. This value should be provided as a list.
+ |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
filters
dictionary
-
- |
- - | -
- A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeCustomerGateways.html for possible filters.
- |
+
+
+ + | +
+ A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeCustomerGateways.html for possible filters.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
bgp_asn
integer
-
- |
- - | -
- Border Gateway Protocol (BGP) Autonomous System Number (ASN), required when state=present.
- |
+
+
+ + | +
+ Border Gateway Protocol (BGP) Autonomous System Number (ASN), required when state=present.
+ |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
ip_address
string
- / required
- |
- - | -
- Internet-routable IP address for customers gateway, must be a static address.
- |
+ / required
+
+ + | +
+ Internet-routable IP address for customers gateway, must be a static address.
+ |
| + | ||||
|
name
string
- / required
- |
- - | -
- Name of the customer gateway.
- |
+ / required
+
+ + | +
+ Name of the customer gateway.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
routing
string
-
- |
-
-
|
-
- The type of routing.
- |
+
+
+
+
|
+
+ The type of routing.
+ |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Create or terminate the Customer Gateway.
- |
+
+
+
+
|
+
+ Create or terminate the Customer Gateway.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
filters
dictionary
-
- |
-
- Default: {}
- |
-
- A dict of filters to apply. Each dict item consists of a filter key and filter value. See https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-addresses.html#options for possible filters. Filter names and values are case sensitive.
- |
+
+
+
+ Default: {}
+ |
+
+ A dict of filters to apply. Each dict item consists of a filter key and filter value. See https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-addresses.html#options for possible filters. Filter names and values are case sensitive.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
allow_reassociation
boolean
-
- |
-
-
|
-
- Specify this option to allow an Elastic IP address that is already associated with another network interface or instance to be re-associated with the specified instance or interface.
- |
+
+
+
+
|
+
+ Specify this option to allow an Elastic IP address that is already associated with another network interface or instance to be re-associated with the specified instance or interface.
+ |
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
device_id
string
-
- |
- - | -
- The id of the device for the EIP. Can be an EC2 Instance id or Elastic Network Interface (ENI) id.
- aliases: instance_id |
+
+
+ + | +
+ The id of the device for the EIP. Can be an EC2 Instance id or Elastic Network Interface (ENI) id.
+ aliases: instance_id |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
in_vpc
boolean
-
- |
-
-
|
-
- Allocate an EIP inside a VPC or not.
- Required if specifying an ENI with device_id.
- |
+
+
+
+
|
+
+ Allocate an EIP inside a VPC or not.
+ Required if specifying an ENI with device_id.
+ |
| + | ||||
|
private_ip_address
string
-
- |
- - | -
- The primary or secondary private IP address to associate with the Elastic IP address.
- |
+
+
+ + | +
+ The primary or secondary private IP address to associate with the Elastic IP address.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
public_ip
string
-
- |
- - | -
- The IP address of a previously allocated EIP.
- When public_ip=present and device is specified, the EIP is associated with the device.
- When public_ip=absent and device is specified, the EIP is disassociated from the device.
- aliases: ip |
+
+
+ + | +
+ The IP address of a previously allocated EIP.
+ When public_ip=present and device is specified, the EIP is associated with the device.
+ When public_ip=absent and device is specified, the EIP is disassociated from the device.
+ aliases: ip |
| + | ||||
|
public_ipv4_pool
string
-
- |
- - | -
- Allocates the new Elastic IP from the provided public IPv4 pool (BYOIP) only applies to newly allocated Elastic IPs, isn't validated when reuse_existing_ip_allowed=true.
- |
+
+
+ + | +
+ Allocates the new Elastic IP from the provided public IPv4 pool (BYOIP) only applies to newly allocated Elastic IPs, isn't validated when reuse_existing_ip_allowed=true.
+ |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
release_on_disassociation
boolean
-
- |
-
-
|
-
- Whether or not to automatically release the EIP when it is disassociated.
- |
+
+
+
+
|
+
+ Whether or not to automatically release the EIP when it is disassociated.
+ |
| + | ||||
|
reuse_existing_ip_allowed
boolean
-
- |
-
-
|
-
- Reuse an EIP that is not associated to a device (when available), instead of allocating a new one.
- |
+
+
+
+
|
+
+ Reuse an EIP that is not associated to a device (when available), instead of allocating a new one.
+ |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- When
- state=present, allocate an EIP or associate an existing EIP with a device.When
- state=absent, disassociate the EIP from the device and optionally release it. |
+
+
+
+
|
+
+ When
+ state=present, allocate an EIP or associate an existing EIP with a device.When
+ state=absent, disassociate the EIP from the device and optionally release it. |
| + | ||||
|
tag_name
string
-
- |
- - | -
- When reuse_existing_ip_allowed=true, supplement with this option to only reuse an Elastic IP if it is tagged with tag_name.
- |
+
+
+ + | +
+ When reuse_existing_ip_allowed=true, supplement with this option to only reuse an Elastic IP if it is tagged with tag_name.
+ |
| + | ||||
|
tag_value
string
-
- |
- - | -
- Supplements tag_name but also checks that the value of the tag provided in tag_name matches tag_value.
- |
+
+
+ + | +
+ Supplements tag_name but also checks that the value of the tag provided in tag_name matches tag_value.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
wait_timeout
integer
-
- |
- - | -
- The wait_timeout option does nothing and will be removed after 2022-06-01
- |
+
+
+ + | +
+ The wait_timeout option does nothing and will be removed after 2022-06-01
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
names
list
-
- |
- - | -
- List of ELB names to gather information about. Pass this option to gather information about a set of ELBs, otherwise, all ELBs are returned.
- |
+ / elements=string
+
+ + | +
+ List of ELB names to gather information about. Pass this option to gather information about a set of ELBs, otherwise, all ELBs are returned.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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_elbs
list
-
- |
- - | -
- List of ELB names, required for registration. The ec2_elbs fact should be used if there was a previous de-register.
- |
+ / elements=string
+
+ + | +
+ List of ELB names, required for registration.
+ The ec2_elbs fact should be used if there was a previous de-register.
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
enable_availability_zone
boolean
-
- |
-
-
|
-
- Whether to enable the availability zone of the instance on the target ELB if the availability zone has not already been enabled. If set to no, the task will fail if the availability zone is not enabled on the ELB.
- |
+
+
+
+
|
+
+ Whether to enable the availability zone of the instance on the target ELB if the availability zone has not already been enabled. If set to no, the task will fail if the availability zone is not enabled on the ELB.
+ |
| + | ||||
|
instance_id
string
- / required
- |
- - | -
- EC2 Instance ID
- |
+ / required
+
+ + | +
+ EC2 Instance ID
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
- / required
- |
-
-
|
-
- register or deregister the instance
- |
+ / required
+
+
+
|
+
+ register or deregister the instance
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
wait
boolean
-
- |
-
-
|
-
- Wait for instance registration or deregistration to complete successfully before returning.
- |
+
+
+
+
|
+
+ Wait for instance registration or deregistration to complete successfully before returning.
+ |
| + | ||||
|
wait_timeout
integer
-
- |
-
- Default: 0
- |
-
- Number of seconds to wait for an instance to change state. If 0 then this module may return an error if a transient error occurs. If non-zero then any transient errors are ignored until the timeout is reached. Ignored when wait=no.
- |
+
+
+
+ Default: 0
+ |
+
+ Number of seconds to wait for an instance to change state. If 0 then this module may return an error if a transient error occurs. If non-zero then any transient errors are ignored until the timeout is reached. Ignored when wait=no.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
filters
dictionary
-
- |
-
- Default: {}
- |
-
- A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html for possible filters. Filter names and values are case sensitive.
- |
+
+
+
+ Default: {}
+ |
+
+ A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html for possible filters. Filter names and values are case sensitive.
+ |
| + | ||||
|
instance_ids
list
-
- |
- - | -
- If you specify one or more instance IDs, only instances that have the specified IDs are returned.
- |
+ / elements=string
+
+ + | +
+ If you specify one or more instance IDs, only instances that have the specified IDs are returned.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
-
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
availability_zone
string
-
- |
- - | -
- Specify an availability zone to use the default subnet it. Useful if not specifying the vpc_subnet_id parameter.
- If no subnet, ENI, or availability zone is provided, the default subnet in the default VPC will be used in the first AZ (alphabetically sorted).
- |
+
+
+ + | +
+ Specify an availability zone to use the default subnet it. Useful if not specifying the vpc_subnet_id parameter.
+ If no subnet, ENI, or availability zone is provided, the default subnet in the default VPC will be used in the first AZ (alphabetically sorted).
+ |
|
| + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
cpu_credit_specification
string
-
- |
-
-
|
-
- For T series instances, choose whether to allow increased charges to buy CPU credits if the default pool is depleted.
- Choose unlimited to enable buying additional CPU credits.
- |
+
+
+
+
|
+
+ For T series instances, choose whether to allow increased charges to buy CPU credits if the default pool is depleted.
+ Choose unlimited to enable buying additional CPU credits.
+ |
|
| + | |||||
|
cpu_options
dictionary
-
- |
- - | -
- Reduce the number of vCPU exposed to the instance.
- Those parameters can only be set at instance launch. The two suboptions threads_per_core and core_count are mandatory.
- See https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html for combinations available.
- Requires botocore >= 1.10.16
- |
- |||
| - | + + | ++ | +
+ Reduce the number of vCPU exposed to the instance.
+ Those parameters can only be set at instance launch. The two suboptions threads_per_core and core_count are mandatory.
+ See https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html for combinations available.
+ Requires botocore >= 1.10.16
+ |
+ ||
| + |
core_count
integer
- / required
- |
- - | -
- Set the number of core to enable.
- |
+ / required
+
+ + | +
+ Set the number of core to enable.
+ |
| - | + | ||||
| + |
threads_per_core
integer
- / required
- |
-
-
|
-
- Select the number of threads per core to enable. Disable or Enable Intel HT.
- |
- ||
| + / required + | +
+
|
+
+ Select the number of threads per core to enable. Disable or Enable Intel HT.
+ |
+ |||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
|
| + | |||||
|
detailed_monitoring
boolean
-
- |
-
-
|
-
- Whether to allow detailed cloudwatch metrics to be collected, enabling more detailed alerting.
- |
+
+
+
+
|
+
+ Whether to allow detailed cloudwatch metrics to be collected, enabling more detailed alerting.
+ |
|
| + | |||||
|
ebs_optimized
boolean
-
- |
-
-
|
-
- Whether instance is should use optimized EBS volumes, see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html.
- |
+
+
+
+
|
+
+ Whether instance is should use optimized EBS volumes, see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html.
+ |
|
| + | |||||
|
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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
filters
dictionary
-
- |
- - | -
- A dict of filters to apply when deciding whether existing instances match and should be altered. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html. for possible filters. Filter names and values are case sensitive.
- By default, instances are filtered for counting by their "Name" tag, base AMI, state (running, by default), and subnet ID. Any queryable filter can be used. Good candidates are specific tags, SSH keys, or security groups.
- |
+
+
+ + | +
+ A dict of filters to apply when deciding whether existing instances match and should be altered. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html. for possible filters. Filter names and values are case sensitive.
+ By default, instances are filtered for counting by their "Name" tag, base AMI, state (running, by default), and subnet ID. Any queryable filter can be used. Good candidates are specific tags, SSH keys, or security groups.
+ |
|
| + | |||||
|
image
dictionary
-
- |
- - | -
- An image to use for the instance. The amazon.aws.ec2_ami_info module may be used to retrieve images. One of image or image_id are required when instance is not already present.
- |
- |||
| - | + + | ++ | +
+ An image to use for the instance. The amazon.aws.ec2_ami_info module may be used to retrieve images. One of image or image_id are required when instance is not already present.
+ |
+ ||
| + |
id
string
-
- |
- - | -
- The AMI ID.
- |
+
+
+ + | +
+ The AMI ID.
+ |
| - | + | ||||
| + |
kernel
-
-
- |
- - | -
- a string AKI to override the AMI kernel.
- |
+
+
+ + | +
+ a string AKI to override the AMI kernel.
+ |
| - | + | ||||
| + |
ramdisk
string
-
- |
- - | -
- Overrides the AMI's default ramdisk ID.
- |
- ||
| + + | ++ | +
+ Overrides the AMI's default ramdisk ID.
+ |
+ |||
|
image_id
string
-
- |
- - | -
- ami ID to use for the instance. One of image or image_id are required when instance is not already present.
- This is an alias for image.id.
- |
+
+
+ + | +
+ ami ID to use for the instance. One of image or image_id are required when instance is not already present.
+ This is an alias for image.id.
+ |
|
| + | |||||
|
instance_ids
list
-
- |
- - | -
- If you specify one or more instance IDs, only instances that have the specified IDs are returned.
- |
+ / elements=string
+
+ + | +
+ If you specify one or more instance IDs, only instances that have the specified IDs are returned.
+ |
|
| + | |||||
|
instance_initiated_shutdown_behavior
string
-
- |
-
-
|
-
- Whether to stop or terminate an instance upon shutdown.
- |
+
+
+
+
|
+
+ Whether to stop or terminate an instance upon shutdown.
+ |
|
| + | |||||
|
instance_role
string
-
- |
- - | -
- The ARN or name of an EC2-enabled instance role to be used. If a name is not provided in arn format then the ListInstanceProfiles permission must also be granted. https://docs.aws.amazon.com/IAM/latest/APIReference/API_ListInstanceProfiles.html If no full ARN is provided, the role with a matching name will be used from the active AWS account.
- |
+
+
+ + | +
+ The ARN or name of an EC2-enabled instance role to be used. If a name is not provided in arn format then the ListInstanceProfiles permission must also be granted. https://docs.aws.amazon.com/IAM/latest/APIReference/API_ListInstanceProfiles.html If no full ARN is provided, the role with a matching name will be used from the active AWS account.
+ |
|
| + | |||||
|
instance_type
string
-
- |
-
- Default: "t2.micro"
- |
-
- Instance type to use for the instance, see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html Only required when instance is not already present.
- |
+
+
+
+ Default: "t2.micro"
+ |
+
+ Instance type to use for the instance, see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html Only required when instance is not already present.
+ |
|
| + | |||||
|
key_name
string
-
- |
- - | -
- Name of the SSH access key to assign to the instance - must exist in the region the instance is created.
- |
+
+
+ + | +
+ Name of the SSH access key to assign to the instance - must exist in the region the instance is created.
+ |
|
| + | |||||
|
launch_template
dictionary
-
- |
- - | -
- The EC2 launch template to base instance configuration on.
- |
- |||
| - | + + | ++ | +
+ The EC2 launch template to base instance configuration on.
+ |
+ ||
| + |
id
string
-
- |
- - | -
- the ID of the launch template (optional if name is specified).
- |
+
+
+ + | +
+ the ID of the launch template (optional if name is specified).
+ |
| - | + | ||||
| + |
name
string
-
- |
- - | -
- the pretty name of the launch template (optional if id is specified).
- |
+
+
+ + | +
+ the pretty name of the launch template (optional if id is specified).
+ |
| - | + | ||||
| + |
version
-
-
- |
- - | -
- the specific version of the launch template to use. If unspecified, the template default is chosen.
- |
- ||
| + + | ++ | +
+ the specific version of the launch template to use. If unspecified, the template default is chosen.
+ |
+ |||
|
name
string
-
- |
- - | -
- The Name tag for the instance.
- |
+
+
+ + | +
+ The Name tag for the instance.
+ |
|
| + | |||||
|
network
dictionary
-
- |
- - | -
- Either a dictionary containing the key 'interfaces' corresponding to a list of network interface IDs or containing specifications for a single network interface.
- Use the amazon.aws.ec2_eni module to create ENIs with special settings.
- |
- |||
| - | + + | ++ | +
+ Either a dictionary containing the key 'interfaces' corresponding to a list of network interface IDs or containing specifications for a single network interface.
+ Use the amazon.aws.ec2_eni module to create ENIs with special settings.
+ |
+ ||
| + |
assign_public_ip
boolean
-
- |
-
-
|
-
- when true assigns a public IP address to the interface
- |
+
+
+
+
|
+
+ when true assigns a public IP address to the interface
+ |
| - | + | ||||
| + |
delete_on_termination
boolean
-
- |
-
-
|
-
- Delete the interface when the instance it is attached to is terminated.
- |
+
+
+
+
|
+
+ Delete the interface when the instance it is attached to is terminated.
+ |
| - | + | ||||
| + |
description
string
-
- |
- - | -
- a description for the network interface
- |
+
+
+ + | +
+ a description for the network interface
+ |
| - | + | ||||
| + |
device_index
integer
-
- |
- - | -
- The index of the interface to modify
- |
+
+
+ + | +
+ The index of the interface to modify
+ |
| - | + | ||||
| + |
groups
list
-
- |
- - | -
- a list of security group IDs to attach to the interface
- |
+
+
+ + | +
+ a list of security group IDs to attach to the interface
+ |
| - | + | ||||
| + |
interfaces
list
-
- |
- - | -
- a list of ENI IDs (strings) or a list of objects containing the key id.
- |
+
+
+ + | +
+ a list of ENI IDs (strings) or a list of objects containing the key id.
+ |
| - | + | ||||
| + |
ipv6_addresses
list
-
- |
- - | -
- a list of IPv6 addresses to assign to the network interface
- |
+
+
+ + | +
+ a list of IPv6 addresses to assign to the network interface
+ |
| - | + | ||||
| + |
private_ip_address
string
-
- |
- - | -
- an IPv4 address to assign to the interface
- |
+
+
+ + | +
+ an IPv4 address to assign to the interface
+ |
| - | + | ||||
| + |
private_ip_addresses
list
-
- |
- - | -
- a list of IPv4 addresses to assign to the network interface
- |
+
+
+ + | +
+ a list of IPv4 addresses to assign to the network interface
+ |
| - | + | ||||
| + |
source_dest_check
boolean
-
- |
-
-
|
-
- controls whether source/destination checking is enabled on the interface
- |
+
+
+
+
|
+
+ controls whether source/destination checking is enabled on the interface
+ |
| - | + | ||||
| + |
subnet_id
string
-
- |
- - | -
- the subnet to connect the network interface to
- |
- ||
| + + | ++ | +
+ the subnet to connect the network interface to
+ |
+ |||
|
placement_group
string
-
- |
- - | -
- The placement group that needs to be assigned to the instance
- |
+
+
+ + | +
+ The placement group that needs to be assigned to the instance
+ |
|
| + | |||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
purge_tags
boolean
-
- |
-
-
|
-
- Delete any tags not specified in the task that are on the instance. This means you have to specify all the desired tags on each task affecting an instance.
- |
+
+
+
+
|
+
+ Delete any tags not specified in the task that are on the instance. This means you have to specify all the desired tags on each task affecting an instance.
+ |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
security_group
string
-
- |
- - | -
- A security group ID or name. Mutually exclusive with security_groups.
- |
+
+
+ + | +
+ A security group ID or name. Mutually exclusive with security_groups.
+ |
|
| + | |||||
|
security_groups
list
-
- |
- - | -
- A list of security group IDs or names (strings). Mutually exclusive with security_group.
- |
+ / elements=string
+
+ + | +
+ A list of security group IDs or names (strings). Mutually exclusive with security_group.
+ |
|
| + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
state
string
-
- |
-
-
|
-
- Goal state for the instances.
- |
- |||
| + + | +
+
|
+
+ Goal state for the instances.
+ |
+ |||
|
tags
dictionary
-
- |
- - | -
- A hash/dictionary of tags to add to the new instance or to add/remove from an existing one.
- |
+
+
+ + | +
+ A hash/dictionary of tags to add to the new instance or to add/remove from an existing one.
+ |
|
| + | |||||
|
tenancy
string
-
- |
-
-
|
-
- What type of tenancy to allow an instance to use. Default is shared tenancy. Dedicated tenancy will incur additional charges.
- |
+
+
+
+
|
+
+ What type of tenancy to allow an instance to use. Default is shared tenancy. Dedicated tenancy will incur additional charges.
+ |
|
| + | |||||
|
termination_protection
boolean
-
- |
-
-
|
-
- Whether to enable termination protection. This module will not terminate an instance with termination protection active, it must be turned off first.
- |
+
+
+
+
|
+
+ Whether to enable termination protection. This module will not terminate an instance with termination protection active, it must be turned off first.
+ |
|
| + | |||||
|
tower_callback
dictionary
-
- |
- - | -
- Preconfigured user-data to enable an instance to perform a Tower callback (Linux only).
- Mutually exclusive with user_data.
- For Windows instances, to enable remote access via Ansible set tower_callback.windows to true, and optionally set an admin password.
- If using 'windows' and 'set_password', callback to Tower will not be performed but the instance will be ready to receive winrm connections from Ansible.
- |
- |||
| - | + + | ++ | +
+ Preconfigured user-data to enable an instance to perform a Tower callback (Linux only).
+ Mutually exclusive with user_data.
+ For Windows instances, to enable remote access via Ansible set tower_callback.windows to true, and optionally set an admin password.
+ If using 'windows' and 'set_password', callback to Tower will not be performed but the instance will be ready to receive winrm connections from Ansible.
+ |
+ ||
| + |
host_config_key
string
-
- |
- - | -
- Host configuration secret key generated by the Tower job template.
- |
+
+
+ + | +
+ Host configuration secret key generated by the Tower job template.
+ |
| - | + | ||||
| + |
job_template_id
string
-
- |
- - | -
- Either the integer ID of the Tower Job Template, or the name (name supported only for Tower 3.2+).
- |
+
+
+ + | +
+ Either the integer ID of the Tower Job Template, or the name (name supported only for Tower 3.2+).
+ |
| - | + | ||||
| + |
tower_address
string
-
- |
- - | -
- IP address or DNS name of Tower server. Must be accessible via this address from the VPC that this instance will be launched in.
- |
- ||
| + + | ++ | +
+ IP address or DNS name of Tower server. Must be accessible via this address from the VPC that this instance will be launched in.
+ |
+ |||
|
user_data
string
-
- |
- - | -
- Opaque blob of data which is made available to the ec2 instance
- |
+
+
+ + | +
+ Opaque blob of data which is made available to the ec2 instance
+ |
|
| + | |||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
|
| + | |||||
|
volumes
list
-
- |
- - | -
- A list of block device mappings, by default this will always use the AMI root device so the volumes option is primarily for adding more storage.
- A mapping contains the (optional) keys device_name, virtual_name, ebs.volume_type, ebs.volume_size, ebs.kms_key_id, ebs.iops, and ebs.delete_on_termination.
- For more information about each parameter, see https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html.
- |
+ / elements=dictionary
+
+ + | +
+ A list of block device mappings, by default this will always use the AMI root device so the volumes option is primarily for adding more storage.
+ A mapping contains the (optional) keys device_name, virtual_name, ebs.volume_type, ebs.volume_size, ebs.kms_key_id, ebs.iops, and ebs.delete_on_termination.
+ For more information about each parameter, see https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html.
+ |
|
| + | |||||
|
vpc_subnet_id
string
-
- |
- - | -
- The subnet ID in which to launch the instance (VPC) If none is provided, community.aws.ec2_instance will chose the default zone of the default VPC.
- aliases: subnet_id |
+
+
+ + | +
+ The subnet ID in which to launch the instance (VPC) If none is provided, community.aws.ec2_instance will chose the default zone of the default VPC.
+ aliases: subnet_id |
|
| + | |||||
|
wait
boolean
-
- |
-
-
|
-
- Whether or not to wait for the desired state (use wait_timeout to customize this).
- |
+
+
+
+
|
+
+ Whether or not to wait for the desired state (use wait_timeout to customize this).
+ |
|
| + | |||||
|
wait_timeout
integer
-
- |
-
- Default: 600
- |
-
- How long to wait (in seconds) for the instance to finish booting/terminating.
- |
- |||
| Parameter | Choices/Defaults | -Comments | +Comments | |||
|---|---|---|---|---|---|---|
| + | ||||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
||
| + | ||||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
||
| + | ||||||
|
block_device_mappings
list
- / elements=dictionary
- |
- - | -
- The block device mapping. Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action.
- |
- ||||
| - | + / elements=dictionary + | ++ | +
+ The block device mapping. Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action.
+ |
+ |||
| + |
device_name
string
-
- |
- - | -
- The device name (for example, /dev/sdh or xvdh).
- |
+
+
+ + | +
+ The device name (for example, /dev/sdh or xvdh).
+ |
|
| - | + | |||||
| + |
ebs
dictionary
-
- |
- - | -
- Parameters used to automatically set up EBS volumes when the instance is launched.
- |
- |||
| - | - | + + | ++ | +
+ Parameters used to automatically set up EBS volumes when the instance is launched.
+ |
+ ||
| + | + |
delete_on_termination
boolean
-
- |
-
-
|
-
- Indicates whether the EBS volume is deleted on instance termination.
- |
+
+
+
+
|
+
+ Indicates whether the EBS volume is deleted on instance termination.
+ |
| - | - | + | ||||
| + | + |
encrypted
boolean
-
- |
-
-
|
-
- Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.
- |
+
+
+
+
|
+
+ Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.
+ |
| - | - | + | ||||
| + | + |
iops
integer
-
- |
- - | -
- The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
- Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.
- |
+
+
+ + | +
+ The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
+ Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.
+ |
| - | - | + | ||||
| + | + |
kms_key_id
string
-
- |
- - | -
- The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
- |
+
+
+ + | +
+ The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
+ |
| - | - | + | ||||
| + | + |
snapshot_id
string
-
- |
- - | -
- The ID of the snapshot to create the volume from.
- |
+
+
+ + | +
+ The ID of the snapshot to create the volume from.
+ |
| - | - | + | ||||
| + | + |
volume_size
integer
-
- |
- - | -
- The size of the volume, in GiB.
- Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
- |
+
+
+ + | +
+ The size of the volume, in GiB.
+ Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
+ |
| - | - | + | ||||
| + | + |
volume_type
string
-
- |
- - | -
- The volume type
- |
- ||
| - | + + | ++ | +
+ The volume type
+ |
+ |||
| + |
no_device
string
-
- |
- - | -
- Suppresses the specified device included in the block device mapping of the AMI.
- |
+
+
+ + | +
+ Suppresses the specified device included in the block device mapping of the AMI.
+ |
|
| - | + | |||||
| + |
virtual_name
string
-
- |
- - | -
- The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
- |
- |||
| + + | ++ | +
+ The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
+ |
+ ||||
|
cpu_options
dictionary
-
- |
- - | -
- Choose CPU settings for the EC2 instances that will be created with this template.
- For more information, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html
- |
- ||||
| - | + + | ++ | +
+ Choose CPU settings for the EC2 instances that will be created with this template.
+ For more information, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html
+ |
+ |||
| + |
core_count
integer
-
- |
- - | -
- The number of CPU cores for the instance.
- |
+
+
+ + | +
+ The number of CPU cores for the instance.
+ |
|
| - | + | |||||
| + |
threads_per_core
integer
-
- |
- - | -
- The number of threads per CPU core. To disable Intel Hyper-Threading Technology for the instance, specify a value of 1. Otherwise, specify the default value of 2.
- |
- |||
| + + | ++ | +
+ The number of threads per CPU core. To disable Intel Hyper-Threading Technology for the instance, specify a value of 1. Otherwise, specify the default value of 2.
+ |
+ ||||
|
credit_specification
dictionary
-
- |
- - | -
- The credit option for CPU usage of the instance. Valid for T2 or T3 instances only.
- |
- ||||
| - | + + | ++ | +
+ The credit option for CPU usage of the instance. Valid for T2 or T3 instances only.
+ |
+ |||
| + |
cpu_credits
string
-
- |
- - | -
- The credit option for CPU usage of a T2 or T3 instance. Valid values are
- standard and unlimited. |
- |||
| + + | ++ | +
+ The credit option for CPU usage of a T2 or T3 instance. Valid values are
+ standard and unlimited. |
+ ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
||
| + | ||||||
|
default_version
string
-
- |
-
- Default: "latest"
- |
-
- Which version should be the default when users spin up new instances based on this template? By default, the latest version will be made the default.
- |
+
+
+
+ Default: "latest"
+ |
+
+ Which version should be the default when users spin up new instances based on this template? By default, the latest version will be made the default.
+ |
||
| + | ||||||
|
disable_api_termination
boolean
-
- |
-
-
|
-
- This helps protect instances from accidental termination. If set to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API. To change this attribute to false after launch, use ModifyInstanceAttribute.
- |
+
+
+
+
|
+
+ This helps protect instances from accidental termination. If set to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API. To change this attribute to false after launch, use ModifyInstanceAttribute.
+ |
||
| + | ||||||
|
ebs_optimized
boolean
-
- |
-
-
|
-
- Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
- |
+
+
+
+
|
+
+ Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
+ |
||
| + | ||||||
|
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.
- |
+
+
+ + | +
+ 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 |
||
| + | ||||||
|
elastic_gpu_specifications
list
- / elements=dictionary
- |
- - | -
- Settings for Elastic GPU attachments. See https://aws.amazon.com/ec2/elastic-gpus/ for details.
- |
- ||||
| - | + / elements=dictionary + | ++ | +
+ Settings for Elastic GPU attachments. See https://aws.amazon.com/ec2/elastic-gpus/ for details.
+ |
+ |||
| + |
type
string
-
- |
- - | -
- The type of Elastic GPU to attach
- |
- |||
| + + | ++ | +
+ The type of Elastic GPU to attach
+ |
+ ||||
|
iam_instance_profile
string
-
- |
- - | -
- The name or ARN of an IAM instance profile. Requires permissions to describe existing instance roles to confirm ARN is properly formed.
- |
+
+
+ + | +
+ The name or ARN of an IAM instance profile. Requires permissions to describe existing instance roles to confirm ARN is properly formed.
+ |
||
| + | ||||||
|
image_id
string
-
- |
- - | -
- The AMI ID to use for new instances launched with this template. This value is region-dependent since AMIs are not global resources.
- |
+
+
+ + | +
+ The AMI ID to use for new instances launched with this template. This value is region-dependent since AMIs are not global resources.
+ |
||
| + | ||||||
|
instance_initiated_shutdown_behavior
string
-
- |
-
-
|
-
- Indicates whether an instance stops or terminates when you initiate shutdown from the instance using the operating system shutdown command.
- |
+
+
+
+
|
+
+ Indicates whether an instance stops or terminates when you initiate shutdown from the instance using the operating system shutdown command.
+ |
||
| + | ||||||
|
instance_market_options
dictionary
-
- |
- - | -
- Options for alternative instance markets, currently only the spot market is supported.
- |
- ||||
| - | + + | ++ | +
+ Options for alternative instance markets, currently only the spot market is supported.
+ |
+ |||
| + |
market_type
string
-
- |
- - | -
- The market type. This should always be 'spot'.
- |
+
+
+ + | +
+ The market type. This should always be 'spot'.
+ |
|
| - | + | |||||
| + |
spot_options
dictionary
-
- |
- - | -
- Spot-market specific settings.
- |
- |||
| - | - | + + | ++ | +
+ Spot-market specific settings.
+ |
+ ||
| + | + |
block_duration_minutes
integer
-
- |
- - | -
- The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
- |
+
+
+ + | +
+ The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
+ |
| - | - | + | ||||
| + | + |
instance_interruption_behavior
string
-
- |
-
-
|
-
- The behavior when a Spot Instance is interrupted. The default is
- terminate. |
+
+
+
+
|
+
+ The behavior when a Spot Instance is interrupted. The default is
+ terminate. |
| - | - | + | ||||
| + | + |
max_price
string
-
- |
- - | -
- The highest hourly price you're willing to pay for this Spot Instance.
- |
+
+
+ + | +
+ The highest hourly price you're willing to pay for this Spot Instance.
+ |
| - | - | + | ||||
| + | + |
spot_instance_type
string
-
- |
-
-
|
-
- The request type to send.
- |
- ||
| + + | +
+
|
+
+ The request type to send.
+ |
+ ||||
|
instance_type
string
-
- |
- - | -
- The instance type, such as
- c5.2xlarge. For a full list of instance types, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html. |
+
+
+ + | +
+ The instance type, such as
+ c5.2xlarge. For a full list of instance types, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html. |
||
| + | ||||||
|
kernel_id
string
-
- |
- - | -
- The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html
- |
+
+
+ + | +
+ The ID of the kernel. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html
+ |
||
| + | ||||||
|
key_name
string
-
- |
- - | -
- The name of the key pair. You can create a key pair using amazon.aws.ec2_key.
- If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
- |
+
+
+ + | +
+ The name of the key pair. You can create a key pair using amazon.aws.ec2_key.
+ If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
+ |
||
| + | ||||||
|
monitoring
dictionary
-
- |
- - | -
- Settings for instance monitoring.
- |
- ||||
| - | + + | ++ | +
+ Settings for instance monitoring.
+ |
+ |||
| + |
enabled
boolean
-
- |
-
-
|
-
- Whether to turn on detailed monitoring for new instances. This will incur extra charges.
- |
- |||
| + + | +
+
|
+
+ Whether to turn on detailed monitoring for new instances. This will incur extra charges.
+ |
+ ||||
|
network_interfaces
list
- / elements=dictionary
- |
- - | -
- One or more network interfaces.
- |
- ||||
| - | + / elements=dictionary + | ++ | +
+ One or more network interfaces.
+ |
+ |||
| + |
associate_public_ip_address
boolean
-
- |
-
-
|
-
- Associates a public IPv4 address with eth0 for a new network interface.
- |
+
+
+
+
|
+
+ Associates a public IPv4 address with eth0 for a new network interface.
+ |
|
| - | + | |||||
| + |
delete_on_termination
boolean
-
- |
-
-
|
-
- Indicates whether the network interface is deleted when the instance is terminated.
- |
+
+
+
+
|
+
+ Indicates whether the network interface is deleted when the instance is terminated.
+ |
|
| - | + | |||||
| + |
description
string
-
- |
- - | -
- A description for the network interface.
- |
+
+
+ + | +
+ A description for the network interface.
+ |
|
| - | + | |||||
| + |
device_index
integer
-
- |
- - | -
- The device index for the network interface attachment.
- |
+
+
+ + | +
+ The device index for the network interface attachment.
+ |
|
| - | + | |||||
| + |
groups
list
- / elements=string
- |
- - | -
- List of security group IDs to include on this instance.
- |
+ / elements=string
+
+ + | +
+ List of security group IDs to include on this instance.
+ |
|
| - | + | |||||
| + |
ipv6_address_count
integer
-
- |
- - | -
- The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying the ipv6_addresses option.
- |
+
+
+ + | +
+ The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying the ipv6_addresses option.
+ |
|
| - | + | |||||
| + |
ipv6_addresses
list
- / elements=string
- |
- - | -
- A list of one or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying the ipv6_address_count option.
- |
+ / elements=string
+
+ + | +
+ A list of one or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying the ipv6_address_count option.
+ |
|
| - | + | |||||
| + |
network_interface_id
string
-
- |
- - | -
- The eni ID of a network interface to attach.
- |
+
+
+ + | +
+ The eni ID of a network interface to attach.
+ |
|
| - | + | |||||
| + |
private_ip_address
string
-
- |
- - | -
- The primary private IPv4 address of the network interface.
- |
+
+
+ + | +
+ The primary private IPv4 address of the network interface.
+ |
|
| - | + | |||||
| + |
subnet_id
string
-
- |
- - | -
- The ID of the subnet for the network interface.
- |
- |||
| + + | ++ | +
+ The ID of the subnet for the network interface.
+ |
+ ||||
|
placement
dictionary
-
- |
- - | -
- The placement group settings for the instance.
- |
- ||||
| - | + + | ++ | +
+ The placement group settings for the instance.
+ |
+ |||
| + |
affinity
string
-
- |
- - | -
- The affinity setting for an instance on a Dedicated Host.
- |
+
+
+ + | +
+ The affinity setting for an instance on a Dedicated Host.
+ |
|
| - | + | |||||
| + |
availability_zone
string
-
- |
- - | -
- The Availability Zone for the instance.
- |
+
+
+ + | +
+ The Availability Zone for the instance.
+ |
|
| - | + | |||||
| + |
group_name
string
-
- |
- - | -
- The name of the placement group for the instance.
- |
+
+
+ + | +
+ The name of the placement group for the instance.
+ |
|
| - | + | |||||
| + |
host_id
string
-
- |
- - | -
- The ID of the Dedicated Host for the instance.
- |
+
+
+ + | +
+ The ID of the Dedicated Host for the instance.
+ |
|
| - | + | |||||
| + |
tenancy
string
-
- |
- - | -
- The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
- |
- |||
| + + | ++ | +
+ The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
+ |
+ ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
||
| + | ||||||
|
ram_disk_id
string
-
- |
- - | -
- The ID of the RAM disk to launch the instance with. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html
- |
+
+
+ + | +
+ The ID of the RAM disk to launch the instance with. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html
+ |
||
| + | ||||||
|
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 |
+
+
+ + | +
+ 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 |
||
| + | ||||||
|
security_group_ids
list
- / elements=string
- |
- - | -
- A list of security group IDs (VPC or EC2-Classic) that the new instances will be added to.
- |
+ / elements=string
+
+ + | +
+ A list of security group IDs (VPC or EC2-Classic) that the new instances will be added to.
+ |
||
| + | ||||||
|
security_groups
list
- / elements=string
- |
- - | -
- A list of security group names (VPC or EC2-Classic) that the new instances will be added to.
- |
+ / elements=string
+
+ + | +
+ A list of security group names (VPC or EC2-Classic) that the new instances will be added to.
+ |
||
| + | ||||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
||
| + | ||||||
|
state
string
-
- |
-
-
|
-
- Whether the launch template should exist or not.
- Deleting specific versions of a launch template is not supported at this time.
- |
+
+
+
+
|
+
+ Whether the launch template should exist or not.
+ Deleting specific versions of a launch template is not supported at this time.
+ |
||
| + | ||||||
|
tags
dictionary
-
- |
- - | -
- A set of key-value pairs to be applied to resources when this Launch Template is used.
- Tag key constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:
- Tag value constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
- |
+
+
+ + | +
+ A set of key-value pairs to be applied to resources when this Launch Template is used.
+ Tag key constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:
+ Tag value constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
+ |
||
| + | ||||||
|
template_id
string
-
- |
- - | -
- The ID for the launch template, can be used for all cases except creating a new Launch Template.
- aliases: id |
+
+
+ + | +
+ The ID for the launch template, can be used for all cases except creating a new Launch Template.
+ aliases: id |
||
| + | ||||||
|
template_name
string
-
- |
- - | -
- The template name. This must be unique in the region-account combination you are using.
- aliases: name |
+
+
+ + | +
+ The template name. This must be unique in the region-account combination you are using.
+ aliases: name |
||
| + | ||||||
|
user_data
string
-
- |
- - | -
- The Base64-encoded user data to make available to the instance. For more information, see the Linux http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html and Windows http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html#instancedata-add-user-data documentation on user-data.
- |
+
+
+ + | +
+ The Base64-encoded user data to make available to the instance. For more information, see the Linux http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html and Windows http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html#instancedata-add-user-data documentation on user-data.
+ |
||
| + | ||||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
- ||||
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
limit
integer
-
- |
- - | -
- How many results to show.
- Corresponds to Python slice notation like list[:limit].
- |
+
+
+ + | +
+ How many results to show.
+ Corresponds to Python slice notation like list[:limit].
+ |
| + | ||||
|
name_regex
string
- / required
- |
- - | -
- A Launch Configuration to match.
- It'll be compiled as regex.
- |
+ / required
+
+ + | +
+ A Launch Configuration to match.
+ It'll be compiled as regex.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
sort_order
string
-
- |
-
-
|
-
- Order in which to sort results.
- |
+
+
+
+
|
+
+ Order in which to sort results.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
name
list
- / elements=string
- |
-
- Default: []
- |
-
- A name or a list of name to match.
- |
+ / elements=string
+
+
+ Default: []
+ |
+
+ A name or a list of name to match.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
sort
string
-
- |
-
-
|
-
- Optional attribute which with to sort the results.
- |
+
+
+
+
|
+
+ Optional attribute which with to sort the results.
+ |
| + | ||||
|
sort_end
integer
-
- |
- - | -
- Which result to end with (when sorting).
- Corresponds to Python slice notation.
- |
+
+
+ + | +
+ Which result to end with (when sorting).
+ Corresponds to Python slice notation.
+ |
| + | ||||
|
sort_order
string
-
- |
-
-
|
-
- Order in which to sort results.
- Only used when the 'sort' parameter is specified.
- |
+
+
+
+
|
+
+ Order in which to sort results.
+ Only used when the 'sort' parameter is specified.
+ |
| + | ||||
|
sort_start
integer
-
- |
- - | -
- Which result to start with (when sorting).
- Corresponds to Python slice notation.
- |
+
+
+ + | +
+ Which result to start with (when sorting).
+ Corresponds to Python slice notation.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
assign_public_ip
boolean
-
- |
-
-
|
-
- Used for Auto Scaling groups that launch instances into an Amazon Virtual Private Cloud. Specifies whether to assign a public IP address to each instance launched in a Amazon VPC.
- |
+
+
+
+
|
+
+ Used for Auto Scaling groups that launch instances into an Amazon Virtual Private Cloud. Specifies whether to assign a public IP address to each instance launched in a Amazon VPC.
+ |
|
| + | |||||
|
associate_public_ip_address
boolean
-
- |
-
-
|
-
- The associate_public_ip_address option does nothing and will be removed after 2022-06-01
- |
+
+
+
+
|
+
+ The associate_public_ip_address option does nothing and will be removed after 2022-06-01
+ |
|
| + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
classic_link_vpc_id
string
-
- |
- - | -
- Id of ClassicLink enabled VPC
- |
+
+
+ + | +
+ Id of ClassicLink enabled VPC
+ |
|
| + | |||||
|
classic_link_vpc_security_groups
list
- / elements=string
- |
- - | -
- A list of security group IDs with which to associate the ClassicLink VPC instances.
- |
+ / elements=string
+
+ + | +
+ A list of security group IDs with which to associate the ClassicLink VPC instances.
+ |
|
| + | |||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
|
| + | |||||
|
ebs_optimized
boolean
-
- |
-
-
|
-
- Specifies whether the instance is optimized for EBS I/O (true) or not (false).
- |
+
+
+
+
|
+
+ Specifies whether the instance is optimized for EBS I/O (true) or not (false).
+ |
|
| + | |||||
|
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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
image_id
string
-
- |
- - | -
- The AMI unique identifier to be used for the group.
- |
+
+
+ + | +
+ The AMI unique identifier to be used for the group.
+ |
|
| + | |||||
|
instance_id
string
-
- |
- - | -
- The Id of a running instance to use as a basis for a launch configuration. Can be used in place of image_id and instance_type.
- |
+
+
+ + | +
+ The Id of a running instance to use as a basis for a launch configuration. Can be used in place of image_id and instance_type.
+ |
|
| + | |||||
|
instance_monitoring
boolean
-
- |
-
-
|
-
- Specifies whether instances are launched with detailed monitoring.
- |
+
+
+
+
|
+
+ Specifies whether instances are launched with detailed monitoring.
+ |
|
| + | |||||
|
instance_profile_name
string
-
- |
- - | -
- The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instances.
- |
+
+
+ + | +
+ The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instances.
+ |
|
| + | |||||
|
instance_type
string
-
- |
- - | -
- Instance type to use for the instance.
- Required when creating a new Launch Configuration.
- |
+
+
+ + | +
+ Instance type to use for the instance.
+ Required when creating a new Launch Configuration.
+ |
|
| + | |||||
|
kernel_id
string
-
- |
- - | -
- Kernel id for the EC2 instance.
- |
+
+
+ + | +
+ Kernel id for the EC2 instance.
+ |
|
| + | |||||
|
key_name
string
-
- |
- - | -
- The SSH key name to be used for access to managed instances.
- |
+
+
+ + | +
+ The SSH key name to be used for access to managed instances.
+ |
|
| + | |||||
|
name
string
- / required
- |
- - | -
- Unique name for configuration.
- |
+ / required
+
+ + | +
+ Unique name for configuration.
+ |
|
| + | |||||
|
placement_tenancy
string
-
- |
-
-
|
-
- Determines whether the instance runs on single-tenant hardware or not.
- When not set AWS will default to
- default. |
+
+
+
+
|
+
+ Determines whether the instance runs on single-tenant hardware or not.
+ When not set AWS will default to
+ default. |
|
| + | |||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
ramdisk_id
string
-
- |
- - | -
- A RAM disk id for the instances.
- |
+
+
+ + | +
+ A RAM disk id for the instances.
+ |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
security_groups
list
- / elements=string
- |
- - | -
- A list of security groups to apply to the instances. Since version 2.4 you can specify either security group names or IDs or a mix. Previous to 2.4, for VPC instances, specify security group IDs and for EC2-Classic, specify either security group names or IDs.
- |
+ / elements=string
+
+ + | +
+ A list of security groups to apply to the instances. Since version 2.4 you can specify either security group names or IDs or a mix. Previous to 2.4, for VPC instances, specify security group IDs and for EC2-Classic, specify either security group names or IDs.
+ |
|
| + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
spot_price
float
-
- |
- - | -
- The spot price you are bidding. Only applies for an autoscaling group with spot instances.
- |
+
+
+ + | +
+ The spot price you are bidding. Only applies for an autoscaling group with spot instances.
+ |
|
| + | |||||
|
state
string
-
- |
-
-
|
-
- Register or deregister the instance.
- |
+
+
+
+
|
+
+ Register or deregister the instance.
+ |
|
| + | |||||
|
user_data
string
-
- |
- - | -
- Opaque blob of data which is made available to the ec2 instance. Mutually exclusive with user_data_path.
- |
+
+
+ + | +
+ Opaque blob of data which is made available to the ec2 instance. Mutually exclusive with user_data_path.
+ |
|
| + | |||||
|
user_data_path
path
-
- |
- - | -
- Path to the file that contains userdata for the ec2 instances. Mutually exclusive with user_data.
- |
+
+
+ + | +
+ Path to the file that contains userdata for the ec2 instances. Mutually exclusive with user_data.
+ |
|
| + | |||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
|
| + | |||||
|
volumes
list
- / elements=dictionary
- |
- - | -
- A list dictionaries defining the volumes to create.
- For any volume, a volume size less than 1 will be interpreted as a request not to create the volume.
- |
- |||
| - | + / elements=dictionary + | ++ | +
+ A list dictionaries defining the volumes to create.
+ For any volume, a volume size less than 1 will be interpreted as a request not to create the volume.
+ |
+ ||
| + |
delete_on_termination
boolean
-
- |
-
-
|
-
- Whether the volume should be automatically deleted when the instance is terminated.
- |
+
+
+
+
|
+
+ Whether the volume should be automatically deleted when the instance is terminated.
+ |
| - | + | ||||
| + |
device_name
string
- / required
- |
- - | -
- The name for the volume (For example
- /dev/sda). |
+ / required
+
+ + | +
+ The name for the volume (For example
+ /dev/sda). |
| - | + | ||||
| + |
encrypted
boolean
-
- |
-
-
|
-
- Whether the volume should be encrypted using the 'aws/ebs' KMS CMK.
- |
+
+
+
+
|
+
+ Whether the volume should be encrypted using the 'aws/ebs' KMS CMK.
+ |
| - | + | ||||
| + |
ephemeral
string
-
- |
- - | -
- Whether the volume should be ephemeral.
- Data on ephemeral volumes is lost when the instance is stopped.
- Mutually exclusive with the snapshot parameter.
- |
- ||
| - | + + | ++ | +
+ Whether the volume should be ephemeral.
+ Data on ephemeral volumes is lost when the instance is stopped.
+ Mutually exclusive with the snapshot parameter.
+ |
+ ||
| + |
iops
integer
-
- |
- - | -
- The number of IOPS per second to provision for the volume.
- Required when volume_type=io1.
- |
+
+
+ + | +
+ The number of IOPS per second to provision for the volume.
+ Required when volume_type=io1.
+ |
| - | + | ||||
| + |
no_device
boolean
-
- |
-
-
|
-
- When no_device=true the device will not be created.
- |
+
+
+
+
|
+
+ When no_device=true the device will not be created.
+ |
| - | + | ||||
| + |
snapshot
string
-
- |
- - | -
- The ID of an EBS snapshot to copy when creating the volume.
- Mutually exclusive with the ephemeral parameter.
- |
+
+
+ + | +
+ The ID of an EBS snapshot to copy when creating the volume.
+ Mutually exclusive with the ephemeral parameter.
+ |
| - | + | ||||
| + |
volume_size
integer
-
- |
- - | -
- The size of the volume (in GiB).
- Required unless one of ephemeral, snapshot or no_device is set.
- |
+
+
+ + | +
+ The size of the volume (in GiB).
+ Required unless one of ephemeral, snapshot or no_device is set.
+ |
| - | + | ||||
| + |
volume_type
string
-
- |
- - | -
- The type of volume to create.
- See https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html for more information on the available volume types.
- |
- ||
| + + | ++ | +
+ The type of volume to create.
+ See https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html for more information on the available volume types.
+ |
+ |||
|
vpc_id
string
-
- |
- - | -
- VPC ID, used when resolving security group names to IDs.
- |
- |||
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
alarm_actions
list
- / elements=string
- |
- - | -
- A list of the names action(s) taken when the alarm is in the
- alarm status, denoted as Amazon Resource Name(s). |
+ / elements=string
+
+ + | +
+ A list of the names action(s) taken when the alarm is in the
+ alarm status, denoted as Amazon Resource Name(s). |
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
comparison
string
-
- |
-
-
|
-
- Determines how the threshold value is compared
- Symbolic comparison operators have been deprecated, and will be removed after 2022-06-22.
- |
+
+
+
+
|
+
+ Determines how the threshold value is compared
+ Symbolic comparison operators have been deprecated, and will be removed after 2022-06-22.
+ |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
description
string
-
- |
- - | -
- A longer description of the alarm.
- |
+
+
+ + | +
+ A longer description of the alarm.
+ |
| + | ||||
|
dimensions
dictionary
-
- |
- - | -
- A dictionary describing which metric the alarm is applied to.
- For more information see the AWS documentation:
-
- |
+
+
+ + | +
+ A dictionary describing which metric the alarm is applied to.
+ For more information see the AWS documentation:
+
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
evaluation_periods
integer
-
- |
- - | -
- The number of times in which the metric is evaluated before final calculation.
- |
+
+
+ + | +
+ The number of times in which the metric is evaluated before final calculation.
+ |
| + | ||||
|
insufficient_data_actions
list
- / elements=string
- |
- - | -
- A list of the names of action(s) to take when the alarm is in the
- insufficient_data status. |
+ / elements=string
+
+ + | +
+ A list of the names of action(s) to take when the alarm is in the
+ insufficient_data status. |
| + | ||||
|
metric
string
-
- |
- - | -
- Name of the monitored metric (e.g.
- CPUUtilization).Metric must already exist.
- |
+
+
+ + | +
+ Name of the monitored metric (e.g.
+ CPUUtilization).Metric must already exist.
+ |
| + | ||||
|
name
string
- / required
- |
- - | -
- Unique name for the alarm.
- |
+ / required
+
+ + | +
+ Unique name for the alarm.
+ |
| + | ||||
|
namespace
string
-
- |
- - | -
- Name of the appropriate namespace (
- AWS/EC2, System/Linux, etc.), which determines the category it will appear under in cloudwatch. |
+
+
+ + | +
+ Name of the appropriate namespace (
+ AWS/EC2, System/Linux, etc.), which determines the category it will appear under in cloudwatch. |
| + | ||||
|
ok_actions
list
- / elements=string
- |
- - | -
- A list of the names of action(s) to take when the alarm is in the
- ok status, denoted as Amazon Resource Name(s). |
+ / elements=string
+
+ + | +
+ A list of the names of action(s) to take when the alarm is in the
+ ok status, denoted as Amazon Resource Name(s). |
| + | ||||
|
period
integer
-
- |
- - | -
- The time (in seconds) between metric evaluations.
- |
+
+
+ + | +
+ The time (in seconds) between metric evaluations.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Register or deregister the alarm.
- |
+
+
+
+
|
+
+ Register or deregister the alarm.
+ |
| + | ||||
|
statistic
string
-
- |
-
-
|
-
- Operation applied to the metric.
- Works in conjunction with period and evaluation_periods to determine the comparison value.
- |
+
+
+
+
|
+
+ Operation applied to the metric.
+ Works in conjunction with period and evaluation_periods to determine the comparison value.
+ |
| + | ||||
|
threshold
float
-
- |
- - | -
- Sets the min/max bound for triggering the alarm.
- |
+
+
+ + | +
+ Sets the min/max bound for triggering the alarm.
+ |
| + | ||||
|
treat_missing_data
string
-
- |
-
-
|
-
- Sets how the alarm handles missing data points.
- |
+
+
+
+
|
+
+ Sets how the alarm handles missing data points.
+ |
| + | ||||
|
unit
string
-
- |
-
-
|
-
- The threshold's unit of measurement.
- |
+
+
+
+
|
+
+ The threshold's unit of measurement.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
names
list
- / elements=string
- |
-
- Default: []
- |
-
- A list of names to filter on. If a listed group does not exist, there will be no corresponding entry in the result; no error will be raised.
- |
+ / elements=string
+
+
+ Default: []
+ |
+
+ A list of names to filter on. If a listed group does not exist, there will be no corresponding entry in the result; no error will be raised.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
name
string
- / required
- |
- - | -
- The name for the placement group.
- |
+ / required
+
+ + | +
+ The name for the placement group.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Create or delete placement group.
- |
+
+
+
+
|
+
+ Create or delete placement group.
+ |
| + | ||||
|
strategy
string
-
- |
-
-
|
-
- Placement group strategy. Cluster will cluster instances into a low-latency group in a single Availability Zone, while Spread spreads instances across underlying hardware.
- |
+
+
+
+
|
+
+ Placement group strategy. Cluster will cluster instances into a low-latency group in a single Availability Zone, while Spread spreads instances across underlying hardware.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
adjustment_type
string
-
- |
-
-
|
-
- The type of change in capacity of the autoscaling group.
- |
+
+
+
+
|
+
+ The type of change in capacity of the autoscaling group.
+ |
| + | ||||
|
asg_name
string
- / required
- |
- - | -
- Name of the associated autoscaling group.
- |
+ / required
+
+ + | +
+ Name of the associated autoscaling group.
+ |
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
cooldown
integer
-
- |
- - | -
- The minimum period of time (in seconds) between which autoscaling actions can take place.
- |
+
+
+ + | +
+ The minimum period of time (in seconds) between which autoscaling actions can take place.
+ |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
min_adjustment_step
integer
-
- |
- - | -
- Minimum amount of adjustment when policy is triggered.
- |
+
+
+ + | +
+ Minimum amount of adjustment when policy is triggered.
+ |
| + | ||||
|
name
string
- / required
- |
- - | -
- Unique name for the scaling policy.
- |
+ / required
+
+ + | +
+ Unique name for the scaling policy.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
scaling_adjustment
integer
-
- |
- - | -
- The amount by which the autoscaling group is adjusted by the policy.
- |
+
+
+ + | +
+ The amount by which the autoscaling group is adjusted by the policy.
+ |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Register or deregister the policy.
- |
+
+
+
+
|
+
+ Register or deregister the policy.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
description
string
-
- |
- - | -
- An optional human-readable string describing purpose of the new Snapshot.
- |
+
+
+ + | +
+ An optional human-readable string describing purpose of the new Snapshot.
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
encrypted
boolean
-
- |
-
-
|
-
- Whether or not the destination Snapshot should be encrypted.
- |
+
+
+
+
|
+
+ Whether or not the destination Snapshot should be encrypted.
+ |
| + | ||||
|
kms_key_id
string
-
- |
- - | -
- KMS key id used to encrypt snapshot. If not specified, AWS defaults to
- alias/aws/ebs. |
+
+
+ + | +
+ KMS key id used to encrypt snapshot. If not specified, AWS defaults to
+ alias/aws/ebs. |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
source_region
string
- / required
- |
- - | -
- The source region the Snapshot should be copied from.
- |
+ / required
+
+ + | +
+ The source region the Snapshot should be copied from.
+ |
| + | ||||
|
source_snapshot_id
string
- / required
- |
- - | -
- The ID of the Snapshot in source region that should be copied.
- |
+ / required
+
+ + | +
+ The ID of the Snapshot in source region that should be copied.
+ |
| + | ||||
|
tags
dictionary
-
- |
- - | -
- A hash/dictionary of tags to add to the new Snapshot; '{"key":"value"}' and '{"key":"value","key":"value"}'
- |
+
+
+ + | +
+ A hash/dictionary of tags to add to the new Snapshot; '{"key":"value"}' and '{"key":"value","key":"value"}'
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
wait
boolean
-
- |
-
-
|
-
- Wait for the copied Snapshot to be in 'Available' state before returning.
- |
+
+
+
+
|
+
+ Wait for the copied Snapshot to be in 'Available' state before returning.
+ |
| + | ||||
|
wait_timeout
integer
-
- |
-
- Default: 600
- |
-
- How long before wait gives up, in seconds.
- |
+
+
+
+ Default: 600
+ |
+
+ How long before wait gives up, in seconds.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
filters
dictionary
-
- |
- - | -
- A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGateways.html for filters.
- |
+
+
+ + | +
+ A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGateways.html for filters.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
transit_gateway_ids
list
-
- |
- - | -
- A list of transit gateway IDs to gather information for.
- aliases: transit_gateway_id |
+ / elements=string
+
+ + | +
+ A list of transit gateway IDs to gather information for.
+ aliases: transit_gateway_id |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
asn
integer
-
- |
- - | -
- A private Autonomous System Number (ASN) for the Amazon side of a BGP session.
- The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
- |
+
+
+ + | +
+ A private Autonomous System Number (ASN) for the Amazon side of a BGP session.
+ The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
+ |
| + | ||||
|
auto_associate
boolean
-
- |
-
-
|
-
- Enable or disable automatic association with the default association route table.
- |
+
+
+
+
|
+
+ Enable or disable automatic association with the default association route table.
+ |
| + | ||||
|
auto_attach
boolean
-
- |
-
-
|
-
- Enable or disable automatic acceptance of attachment requests.
- |
+
+
+
+
|
+
+ Enable or disable automatic acceptance of attachment requests.
+ |
| + | ||||
|
auto_propagate
boolean
-
- |
-
-
|
-
- Enable or disable automatic propagation of routes to the default propagation route table.
- |
+
+
+
+
|
+
+ Enable or disable automatic propagation of routes to the default propagation route table.
+ |
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
description
string
-
- |
- - | -
- The description of the transit gateway.
- |
+
+
+ + | +
+ The description of the transit gateway.
+ |
| + | ||||
|
dns_support
boolean
-
- |
-
-
|
-
- Whether to enable AWS DNS support.
- |
+
+
+
+
|
+
+ Whether to enable AWS DNS support.
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
purge_tags
boolean
-
- |
-
-
|
-
- Whether to purge existing tags not included with tags argument.
- |
+
+
+
+
|
+
+ Whether to purge existing tags not included with tags argument.
+ |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- present to ensure resource is created.absent to remove resource. |
+
+
+
+
|
+
+ present to ensure resource is created.absent to remove resource. |
| + | ||||
|
tags
dictionary
-
- |
- - | -
- A dictionary of resource tags
- |
+
+
+ + | +
+ A dictionary of resource tags
+ |
| + | ||||
|
transit_gateway_id
string
-
- |
- - | -
- The ID of the transit gateway.
- |
+
+
+ + | +
+ The ID of the transit gateway.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
vpn_ecmp_support
boolean
-
- |
-
-
|
-
- Enable or disable Equal Cost Multipath Protocol support.
- |
+
+
+
+
|
+
+ Enable or disable Equal Cost Multipath Protocol support.
+ |
| + | ||||
|
wait
boolean
-
- |
-
-
|
-
- Whether to wait for status
- |
+
+
+
+
|
+
+ Whether to wait for status
+ |
| + | ||||
|
wait_timeout
integer
-
- |
-
- Default: 300
- |
-
- number of seconds to wait for status
- |
-
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Create or delete the EIGW.
- |
+
+
+
+
|
+
+ Create or delete the EIGW.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
vpc_id
string
- / required
- |
- - | -
- The VPC ID for the VPC that this Egress Only Internet Gateway should be attached.
- |
+ / required
+
+ + | +
+ The VPC ID for the VPC that this Egress Only Internet Gateway should be attached.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
filters
dictionary
-
- |
- - | -
- A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcEndpoints.html for possible filters.
- |
+
+
+ + | +
+ A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcEndpoints.html for possible filters.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
query
string
- / required
- |
-
-
|
-
- Specifies the query action to take. Services returns the supported AWS services that can be specified when creating an endpoint.
- |
+ / required
+
+
+
|
+
+ Specifies the query action to take. Services returns the supported AWS services that can be specified when creating an endpoint.
+ |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
vpc_endpoint_ids
list
- / elements=string
- |
- - | -
- Get details of specific endpoint IDs
- |
+ / elements=string
+
+ + | +
+ Get details of specific endpoint IDs
+ |
servicesendpoints| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
client_token
string
-
- |
- - | -
- Optional client token to ensure idempotency
- |
+
+
+ + | +
+ Optional client token to ensure idempotency
+ |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
policy
json
-
- |
- - | -
- A properly formatted json policy as string, see https://github.com/ansible/ansible/issues/7005#issuecomment-42894813. Cannot be used with policy_file.
- Option when creating an endpoint. If not provided AWS will utilise a default policy which provides full access to the service.
- |
+
+
+ + | +
+ A properly formatted json policy as string, see https://github.com/ansible/ansible/issues/7005#issuecomment-42894813. Cannot be used with policy_file.
+ Option when creating an endpoint. If not provided AWS will utilise a default policy which provides full access to the service.
+ |
| + | ||||
|
policy_file
path
-
- |
- - | -
- The path to the properly json formatted policy file, see https://github.com/ansible/ansible/issues/7005#issuecomment-42894813 on how to use it properly. Cannot be used with policy.
- Option when creating an endpoint. If not provided AWS will utilise a default policy which provides full access to the service.
- aliases: policy_path |
+
+
+ + | +
+ The path to the properly json formatted policy file, see https://github.com/ansible/ansible/issues/7005#issuecomment-42894813 on how to use it properly. Cannot be used with policy.
+ Option when creating an endpoint. If not provided AWS will utilise a default policy which provides full access to the service.
+ aliases: policy_path |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
route_table_ids
list
- / elements=string
- |
- - | -
- List of one or more route table ids to attach to the endpoint. A route is added to the route table with the destination of the endpoint if provided.
- |
+ / elements=string
+
+ + | +
+ List of one or more route table ids to attach to the endpoint. A route is added to the route table with the destination of the endpoint if provided.
+ |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
service
string
-
- |
- - | -
- An AWS supported vpc endpoint service. Use the community.aws.ec2_vpc_endpoint_info module to describe the supported endpoint services.
- Required when creating an endpoint.
- |
+
+
+ + | +
+ An AWS supported vpc endpoint service. Use the community.aws.ec2_vpc_endpoint_info module to describe the supported endpoint services.
+ Required when creating an endpoint.
+ |
| + | ||||
|
state
string
-
- |
-
-
|
-
- present to ensure resource is created.
- absent to remove resource
- |
+
+
+
+
|
+
+ present to ensure resource is created.
+ absent to remove resource
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
vpc_endpoint_id
string
-
- |
- - | -
- One or more vpc endpoint ids to remove from the AWS account
- |
+
+
+ + | +
+ One or more vpc endpoint ids to remove from the AWS account
+ |
| + | ||||
|
vpc_id
string
-
- |
- - | -
- Required when creating a VPC endpoint.
- |
+
+
+ + | +
+ Required when creating a VPC endpoint.
+ |
| + | ||||
|
wait
boolean
-
- |
-
-
|
-
- When specified, will wait for either available status for state present. Unfortunately this is ignored for delete actions due to a difference in behaviour from AWS.
- |
+
+
+
+
|
+
+ When specified, will wait for either available status for state present. Unfortunately this is ignored for delete actions due to a difference in behaviour from AWS.
+ |
| + | ||||
|
wait_timeout
integer
-
- |
-
- Default: 320
- |
-
- Used in conjunction with wait. Number of seconds to wait for status. Unfortunately this is ignored for delete actions due to a difference in behaviour from AWS.
- |
+
+
+
+ Default: 320
+ |
+
+ Used in conjunction with wait. Number of seconds to wait for status. Unfortunately this is ignored for delete actions due to a difference in behaviour from AWS.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
filters
dictionary
-
- |
- - | -
- A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInternetGateways.html for possible filters.
- |
+
+
+ + | +
+ A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInternetGateways.html for possible filters.
+ |
| + | ||||
|
internet_gateway_ids
list
- / elements=string
- |
- - | -
- Get details of specific Internet Gateway ID. Provide this value as a list.
- |
+ / elements=string
+
+ + | +
+ Get details of specific Internet Gateway ID. Provide this value as a list.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Create or terminate the IGW
- |
+
+
+
+
|
+
+ Create or terminate the IGW
+ |
| + | ||||
|
tags
dictionary
-
- |
- - | -
- A dict of tags to apply to the internet gateway. Any tags currently applied to the internet gateway and not present here will be removed.
- aliases: resource_tags |
+
+
+ + | +
+ A dict of tags to apply to the internet gateway. Any tags currently applied to the internet gateway and not present here will be removed.
+ aliases: resource_tags |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
vpc_id
string
- / required
- |
- - | -
- The VPC ID for the VPC in which to manage the Internet Gateway.
- |
+ / required
+
+ + | +
+ The VPC ID for the VPC in which to manage the Internet Gateway.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
filters
dictionary
-
- |
-
- Default: {}
- |
-
- A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkAcls.html for possible filters. Filter names and values are case sensitive.
- |
+
+
+
+ Default: {}
+ |
+
+ A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkAcls.html for possible filters. Filter names and values are case sensitive.
+ |
| + | ||||
|
nacl_ids
list
-
- |
-
- Default: []
- |
-
- A list of Network ACL IDs to retrieve information about.
- aliases: nacl_id |
+ / elements=string
+
+
+ Default: []
+ |
+
+ A list of Network ACL IDs to retrieve information about.
+ aliases: nacl_id |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
[rule no, protocol, allow/deny, v4 or v6 cidr, icmp_type, icmp_code, port from, port to][rule no, protocol, allow/deny, v4 or v6 cidr, icmp_type, icmp_code, port from, port to][rule no, protocol, allow/deny, v4 or v6 cidr, icmp_type, icmp_code, port from, port to][rule no, protocol, allow/deny, v4 or v6 cidr, icmp_type, icmp_code, port from, port to]| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
egress
list
-
- |
-
- Default: []
- |
-
- A list of rules for outgoing traffic. Each rule must be specified as a list. Each rule may contain the rule number (integer 1-32766), protocol (one of ['tcp', 'udp', 'icmp', '-1', 'all']), the rule action ('allow' or 'deny') the CIDR of the IPv4 network range to allow or deny, the ICMP type (-1 means all types), the ICMP code (-1 means all codes), the last port in the range for TCP or UDP protocols, and the first port in the range for TCP or UDP protocols. See examples.
- |
+ / elements=list
+
+
+ Default: []
+ |
+
+ A list of rules for outgoing traffic. Each rule must be specified as a list. Each rule may contain the rule number (integer 1-32766), protocol (one of ['tcp', 'udp', 'icmp', '-1', 'all']), the rule action ('allow' or 'deny') the CIDR of the IPv4 network range to allow or deny, the ICMP type (-1 means all types), the ICMP code (-1 means all codes), the last port in the range for TCP or UDP protocols, and the first port in the range for TCP or UDP protocols. See examples.
+ |
| + | ||||
|
ingress
list
-
- |
-
- Default: []
- |
-
- List of rules for incoming traffic. Each rule must be specified as a list. Each rule may contain the rule number (integer 1-32766), protocol (one of ['tcp', 'udp', 'icmp', '-1', 'all']), the rule action ('allow' or 'deny') the CIDR of the IPv4 network range to allow or deny, the ICMP type (-1 means all types), the ICMP code (-1 means all codes), the last port in the range for TCP or UDP protocols, and the first port in the range for TCP or UDP protocols. See examples.
- |
+ / elements=list
+
+
+ Default: []
+ |
+
+ List of rules for incoming traffic. Each rule must be specified as a list. Each rule may contain the rule number (integer 1-32766), protocol (one of ['tcp', 'udp', 'icmp', '-1', 'all']), the rule action ('allow' or 'deny') the CIDR of the IPv4 network range to allow or deny, the ICMP type (-1 means all types), the ICMP code (-1 means all codes), the last port in the range for TCP or UDP protocols, and the first port in the range for TCP or UDP protocols. See examples.
+ |
| + | ||||
|
nacl_id
string
-
- |
- - | -
- NACL id identifying a network ACL.
- One and only one of the name or nacl_id is required.
- |
+
+
+ + | +
+ NACL id identifying a network ACL.
+ One and only one of the name or nacl_id is required.
+ |
| + | ||||
|
name
string
-
- |
- - | -
- Tagged name identifying a network ACL.
- One and only one of the name or nacl_id is required.
- |
+
+
+ + | +
+ Tagged name identifying a network ACL.
+ One and only one of the name or nacl_id is required.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Creates or modifies an existing NACL
- Deletes a NACL and reassociates subnets to the default NACL
- |
+
+
+
+
|
+
+ Creates or modifies an existing NACL
+ Deletes a NACL and reassociates subnets to the default NACL
+ |
| + | ||||
|
subnets
list
-
- |
- - | -
- The list of subnets that should be associated with the network ACL.
- Must be specified as a list
- Each subnet can be specified as subnet ID, or its tagged name.
- |
+ / elements=string
+
+ + | +
+ The list of subnets that should be associated with the network ACL.
+ Must be specified as a list
+ Each subnet can be specified as subnet ID, or its tagged name.
+ |
| + | ||||
|
tags
dictionary
-
- |
- - | -
- Dictionary of tags to look for and apply when creating a network ACL.
- |
+
+
+ + | +
+ Dictionary of tags to look for and apply when creating a network ACL.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
vpc_id
string
-
- |
- - | -
- VPC id of the requesting VPC.
- Required when state present.
- |
+
+
+ + | +
+ VPC id of the requesting VPC.
+ Required when state present.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
filters
dictionary
-
- |
- - | -
- A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNatGateways.html for possible filters.
- |
+
+
+ + | +
+ A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNatGateways.html for possible filters.
+ |
| + | ||||
|
nat_gateway_ids
list
- / elements=string
- |
- - | -
- List of specific nat gateway IDs to fetch details for.
- |
+ / elements=string
+
+ + | +
+ List of specific nat gateway IDs to fetch details for.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
allocation_id
string
-
- |
- - | -
- The id of the elastic IP allocation. If this is not passed and the eip_address is not passed. An EIP is generated for this NAT Gateway.
- |
+
+
+ + | +
+ The id of the elastic IP allocation. If this is not passed and the eip_address is not passed. An EIP is generated for this NAT Gateway.
+ |
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
client_token
string
-
- |
- - | -
- Optional unique token to be used during create to ensure idempotency. When specifying this option, ensure you specify the eip_address parameter as well otherwise any subsequent runs will fail.
- |
+
+
+ + | +
+ Optional unique token to be used during create to ensure idempotency. When specifying this option, ensure you specify the eip_address parameter as well otherwise any subsequent runs will fail.
+ |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
eip_address
string
-
- |
- - | -
- The elastic IP address of the EIP you want attached to this NAT Gateway. If this is not passed and the allocation_id is not passed, an EIP is generated for this NAT Gateway.
- |
+
+
+ + | +
+ The elastic IP address of the EIP you want attached to this NAT Gateway. If this is not passed and the allocation_id is not passed, an EIP is generated for this NAT Gateway.
+ |
| + | ||||
|
if_exist_do_not_create
boolean
-
- |
-
-
|
-
- if a NAT Gateway exists already in the subnet_id, then do not create a new one.
- |
+
+
+
+
|
+
+ if a NAT Gateway exists already in the subnet_id, then do not create a new one.
+ |
| + | ||||
|
nat_gateway_id
string
-
- |
- - | -
- The id AWS dynamically allocates to the NAT Gateway on creation. This is required when the absent option is present.
- |
+
+
+ + | +
+ The id AWS dynamically allocates to the NAT Gateway on creation. This is required when the absent option is present.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
release_eip
boolean
-
- |
-
-
|
-
- Deallocate the EIP from the VPC.
- Option is only valid with the absent state.
- You should use this with the wait option. Since you can not release an address while a delete operation is happening.
- |
+
+
+
+
|
+
+ Deallocate the EIP from the VPC.
+ Option is only valid with the absent state.
+ You should use this with the wait option. Since you can not release an address while a delete operation is happening.
+ |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Ensure NAT Gateway is present or absent.
- |
+
+
+
+
|
+
+ Ensure NAT Gateway is present or absent.
+ |
| + | ||||
|
subnet_id
string
-
- |
- - | -
- The id of the subnet to create the NAT Gateway in. This is required with the present option.
- |
+
+
+ + | +
+ The id of the subnet to create the NAT Gateway in. This is required with the present option.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
wait
boolean
-
- |
-
-
|
-
- Wait for operation to complete before returning.
- |
+
+
+
+
|
+
+ Wait for operation to complete before returning.
+ |
| + | ||||
|
wait_timeout
integer
-
- |
-
- Default: 320
- |
-
- How many seconds to wait for an operation to complete before timing out.
- |
+
+
+
+ Default: 320
+ |
+
+ How many seconds to wait for an operation to complete before timing out.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
peer_owner_id
string
-
- |
- - | -
- The AWS account number for cross account peering.
- |
+
+
+ + | +
+ The AWS account number for cross account peering.
+ |
| + | ||||
|
peer_region
string
-
- |
- - | -
- Region of the accepting VPC.
- |
+
+
+ + | +
+ Region of the accepting VPC.
+ |
| + | ||||
|
peer_vpc_id
string
-
- |
- - | -
- VPC id of the accepting VPC.
- |
+
+
+ + | +
+ VPC id of the accepting VPC.
+ |
| + | ||||
|
peering_id
string
-
- |
- - | -
- Peering connection id.
- |
+
+
+ + | +
+ Peering connection id.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Create, delete, accept, reject a peering connection.
- |
+
+
+
+
|
+
+ Create, delete, accept, reject a peering connection.
+ |
| + | ||||
|
tags
dictionary
-
- |
- - | -
- Dictionary of tags to look for and apply when creating a Peering Connection.
- |
+
+
+ + | +
+ Dictionary of tags to look for and apply when creating a Peering Connection.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
vpc_id
string
-
- |
- - | -
- VPC id of the requesting VPC.
- |
+
+
+ + | +
+ VPC id of the requesting VPC.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
filters
dictionary
-
- |
- - | -
- A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcPeeringConnections.html for possible filters.
- |
+
+
+ + | +
+ A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcPeeringConnections.html for possible filters.
+ |
| + | ||||
|
peer_connection_ids
list
- / elements=string
- |
- - | -
- List of specific VPC peer IDs to get details for.
- |
+ / elements=string
+
+ + | +
+ List of specific VPC peer IDs to get details for.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
filters
dictionary
-
- |
- - | -
- A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeRouteTables.html for possible filters.
- |
+
+
+ + | +
+ A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeRouteTables.html for possible filters.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
lookup
string
-
- |
-
-
|
-
- Look up route table by either tags or by route table ID. Non-unique tag lookup will fail. If no tags are specified then no lookup for an existing route table is performed and a new route table will be created. To change tags of a route table you must look up by id.
- |
+
+
+
+
|
+
+ Look up route table by either tags or by route table ID. Non-unique tag lookup will fail. If no tags are specified then no lookup for an existing route table is performed and a new route table will be created. To change tags of a route table you must look up by id.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
propagating_vgw_ids
list
- / elements=string
- |
- - | -
- Enable route propagation from virtual gateways specified by ID.
- |
+ / elements=string
+
+ + | +
+ Enable route propagation from virtual gateways specified by ID.
+ |
| + | ||||
|
purge_routes
boolean
-
- |
-
-
|
-
- Purge existing routes that are not found in routes.
- |
+
+
+
+
|
+
+ Purge existing routes that are not found in routes.
+ |
| + | ||||
|
purge_subnets
boolean
-
- |
-
-
"true"
- |
-
- Purge existing subnets that are not found in subnets. Ignored unless the subnets option is supplied.
- |
+
+
+
+
"true"
+ |
+
+ Purge existing subnets that are not found in subnets. Ignored unless the subnets option is supplied.
+ |
| + | ||||
|
purge_tags
boolean
-
- |
-
-
|
-
- Purge existing tags that are not found in route table.
- |
+
+
+
+
|
+
+ Purge existing tags that are not found in route table.
+ |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
route_table_id
string
-
- |
- - | -
- The ID of the route table to update or delete.
- Required when lookup=id.
- |
+
+
+ + | +
+ The ID of the route table to update or delete.
+ Required when lookup=id.
+ |
| + | ||||
|
routes
list
- / elements=dictionary
- |
- - | -
- List of routes in the route table. Routes are specified as dicts containing the keys 'dest' and one of 'gateway_id', 'instance_id', 'network_interface_id', or 'vpc_peering_connection_id'. If 'gateway_id' is specified, you can refer to the VPC's IGW by using the value 'igw'. Routes are required for present states.
- |
+ / elements=dictionary
+
+ + | +
+ List of routes in the route table. Routes are specified as dicts containing the keys 'dest' and one of 'gateway_id', 'instance_id', 'network_interface_id', or 'vpc_peering_connection_id'. If 'gateway_id' is specified, you can refer to the VPC's IGW by using the value 'igw'. Routes are required for present states.
+ |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Create or destroy the VPC route table.
- |
+
+
+
+
|
+
+ Create or destroy the VPC route table.
+ |
| + | ||||
|
subnets
list
- / elements=string
- |
- - | -
- An array of subnets to add to this route table. Subnets may be specified by either subnet ID, Name tag, or by a CIDR such as '10.0.0.0/24'.
- |
+ / elements=string
+
+ + | +
+ An array of subnets to add to this route table. Subnets may be specified by either subnet ID, Name tag, or by a CIDR such as '10.0.0.0/24'.
+ |
| + | ||||
|
tags
dictionary
-
- |
- - | -
- A dictionary of resource tags of the form:
- { tag1: value1, tag2: value2 }. Tags are used to uniquely identify route tables within a VPC when the route_table_id is not supplied.aliases: resource_tags |
+
+
+ + | +
+ A dictionary of resource tags of the form:
+ { tag1: value1, tag2: value2 }. Tags are used to uniquely identify route tables within a VPC when the route_table_id is not supplied.aliases: resource_tags |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
vpc_id
string
-
- |
- - | -
- VPC ID of the VPC in which to create the route table.
- Required when state=present or lookup=tag.
- |
-
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
filters
dictionary
-
- |
- - | -
- A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnGateways.html for possible filters.
- |
+
+
+ + | +
+ A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnGateways.html for possible filters.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
vpn_gateway_ids
list
- / elements=string
- |
- - | -
- Get details of a specific Virtual Gateway ID. This value should be provided as a list.
- |
+ / elements=string
+
+ + | +
+ Get details of a specific Virtual Gateway ID. This value should be provided as a list.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
asn
integer
-
- |
- - | -
- the BGP ASN of the amazon side
- |
+
+
+ + | +
+ the BGP ASN of the amazon side
+ |
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
name
string
-
- |
- - | -
- name of the vgw to be created or deleted
- |
+
+
+ + | +
+ name of the vgw to be created or deleted
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- present to ensure resource is created.
- absent to remove resource
- |
+
+
+
+
|
+
+ present to ensure resource is created.
+ absent to remove resource
+ |
| + | ||||
|
tags
dictionary
-
- |
- - | -
- dictionary of resource tags
- aliases: resource_tags |
+
+
+ + | +
+ dictionary of resource tags
+ aliases: resource_tags |
| + | ||||
|
type
string
-
- |
-
-
|
-
- type of the virtual gateway to be created
- |
+
+
+
+
|
+
+ type of the virtual gateway to be created
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
vpc_id
string
-
- |
- - | -
- the vpc-id of a vpc to attach or detach
- |
+
+
+ + | +
+ the vpc-id of a vpc to attach or detach
+ |
| + | ||||
|
vpn_gateway_id
string
-
- |
- - | -
- vpn gateway id of an existing virtual gateway
- |
+
+
+ + | +
+ vpn gateway id of an existing virtual gateway
+ |
| + | ||||
|
wait_timeout
integer
-
- |
-
- Default: 320
- |
-
- number of seconds to wait for status during vpc attach and detach
- |
+
+
+
+ Default: 320
+ |
+
+ number of seconds to wait for status during vpc attach and detach
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
filters
dictionary
-
- |
- - | -
- A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnConnections.html for possible filters.
- |
+
+
+ + | +
+ A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnConnections.html for possible filters.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
vpn_connection_ids
list
- / elements=string
- |
- - | -
- Get details of a specific VPN connections using vpn connection ID/IDs. This value should be provided as a list.
- |
-
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
connection_type
string
-
- |
-
- Default: "ipsec.1"
- |
-
- The type of VPN connection.
- At this time only 'ipsec.1' is supported.
- |
+
+
+
+ Default: "ipsec.1"
+ |
+
+ The type of VPN connection.
+ At this time only 'ipsec.1' is supported.
+ |
|
| + | |||||
|
customer_gateway_id
string
-
- |
- - | -
- The ID of the customer gateway.
- |
+
+
+ + | +
+ The ID of the customer gateway.
+ |
|
| + | |||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
|
| + | |||||
|
delay
integer
-
- |
-
- Default: 15
- |
-
- The time to wait before checking operation again. in seconds.
- |
+
+
+
+ Default: 15
+ |
+
+ The time to wait before checking operation again. in seconds.
+ |
|
| + | |||||
|
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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
filters
dictionary
-
- |
- - | -
- An alternative to using vpn_connection_id. If multiple matches are found, vpn_connection_id is required. If one of the following suboptions is a list of items to filter by, only one item needs to match to find the VPN that correlates. e.g. if the filter 'cidr' is ['194.168.2.0/24', '192.168.2.0/24'] and the VPN route only has the destination cidr block of '192.168.2.0/24' it will be found with this filter (assuming there are not multiple VPNs that are matched). Another example, if the filter 'vpn' is equal to ['vpn-ccf7e7ad', 'vpn-cb0ae2a2'] and one of of the VPNs has the state deleted (exists but is unmodifiable) and the other exists and is not deleted, it will be found via this filter. See examples.
- |
- |||
| - | + + | ++ | +
+ An alternative to using vpn_connection_id. If multiple matches are found, vpn_connection_id is required. If one of the following suboptions is a list of items to filter by, only one item needs to match to find the VPN that correlates. e.g. if the filter 'cidr' is ['194.168.2.0/24', '192.168.2.0/24'] and the VPN route only has the destination cidr block of '192.168.2.0/24' it will be found with this filter (assuming there are not multiple VPNs that are matched). Another example, if the filter 'vpn' is equal to ['vpn-ccf7e7ad', 'vpn-cb0ae2a2'] and one of of the VPNs has the state deleted (exists but is unmodifiable) and the other exists and is not deleted, it will be found via this filter. See examples.
+ |
+ ||
| + |
bgp
-
-
- |
- - | -
- The BGP ASN number associated with a BGP device. Only works if the connection is attached. This filtering option is currently not working.
- |
+
+
+ + | +
+ The BGP ASN number associated with a BGP device. Only works if the connection is attached. This filtering option is currently not working.
+ |
| - | + | ||||
| + |
cgw
-
-
- |
- - | -
- The customer gateway id as a string or a list of those strings.
- |
+
+
+ + | +
+ The customer gateway id as a string or a list of those strings.
+ |
| - | + | ||||
| + |
cgw-config
-
-
- |
- - | -
- The customer gateway configuration of the VPN as a string (in the format of the return value) or a list of those strings.
- |
+
+
+ + | +
+ The customer gateway configuration of the VPN as a string (in the format of the return value) or a list of those strings.
+ |
| - | + | ||||
| + |
cidr
-
-
- |
- - | -
- The destination cidr of the VPN's route as a string or a list of those strings.
- |
+
+
+ + | +
+ The destination cidr of the VPN's route as a string or a list of those strings.
+ |
| - | + | ||||
| + |
static-routes-only
-
-
- |
- - | -
- The type of routing; true or false.
- |
+
+
+ + | +
+ The type of routing; true or false.
+ |
| - | + | ||||
| + |
tag-keys
-
-
- |
- - | -
- The key of a tag as a string or a list of those strings.
- |
+
+
+ + | +
+ The key of a tag as a string or a list of those strings.
+ |
| - | + | ||||
| + |
tag-values
-
-
- |
- - | -
- The value of a tag as a string or a list of those strings.
- |
+
+
+ + | +
+ The value of a tag as a string or a list of those strings.
+ |
| - | + | ||||
| + |
tags
-
-
- |
- - | -
- A dict of key value pairs.
- |
+
+
+ + | +
+ A dict of key value pairs.
+ |
| - | + | ||||
| + |
vgw
-
-
- |
- - | -
- The virtual private gateway as a string or a list of those strings.
- |
+
+
+ + | +
+ The virtual private gateway as a string or a list of those strings.
+ |
| - | + | ||||
| + |
vpn
-
-
- |
- - | -
- The VPN connection id as a string or a list of those strings.
- |
- ||
| + + | ++ | +
+ The VPN connection id as a string or a list of those strings.
+ |
+ |||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
purge_routes
boolean
-
- |
-
-
|
-
- Whether or not to delete VPN connections routes that are not specified in the task.
- |
+
+
+
+
|
+
+ Whether or not to delete VPN connections routes that are not specified in the task.
+ |
|
| + | |||||
|
purge_tags
boolean
-
- |
-
-
|
-
- Whether or not to delete VPN connections tags that are associated with the connection but not specified in the task.
- |
+
+
+
+
|
+
+ Whether or not to delete VPN connections tags that are associated with the connection but not specified in the task.
+ |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
routes
list
- / elements=string
- |
- - | -
- Routes to add to the connection.
- |
+ / elements=string
+
+ + | +
+ Routes to add to the connection.
+ |
|
| + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
state
string
-
- |
-
-
|
-
- The desired state of the VPN connection.
- |
+
+
+
+
|
+
+ The desired state of the VPN connection.
+ |
|
| + | |||||
|
static_only
boolean
-
- |
-
-
|
-
- Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
- |
+
+
+
+
|
+
+ Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
+ |
|
| + | |||||
|
tags
dictionary
-
- |
- - | -
- Tags to attach to the VPN connection.
- |
+
+
+ + | +
+ Tags to attach to the VPN connection.
+ |
|
| + | |||||
|
tunnel_options
list
- / elements=dictionary
- |
- - | -
- An optional list object containing no more than two dict members, each of which may contain 'TunnelInsideCidr' and/or 'PreSharedKey' keys with appropriate string values. AWS defaults will apply in absence of either of the aforementioned keys.
- |
- |||
| - | + / elements=dictionary + | ++ | +
+ An optional list object containing no more than two dict members, each of which may contain 'TunnelInsideCidr' and/or 'PreSharedKey' keys with appropriate string values. AWS defaults will apply in absence of either of the aforementioned keys.
+ |
+ ||
| + |
PreSharedKey
string
-
- |
- - | -
- The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway.
- |
+
+
+ + | +
+ The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway.
+ |
| - | + | ||||
| + |
TunnelInsideCidr
string
-
- |
- - | -
- The range of inside IP addresses for the tunnel.
- |
- ||
| + + | ++ | +
+ The range of inside IP addresses for the tunnel.
+ |
+ |||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
|
| + | |||||
|
vpn_connection_id
string
-
- |
- - | -
- The ID of the VPN connection. Required to modify or delete a connection if the filters option does not provide a unique match.
- |
+
+
+ + | +
+ The ID of the VPN connection. Required to modify or delete a connection if the filters option does not provide a unique match.
+ |
|
| + | |||||
|
vpn_gateway_id
string
-
- |
- - | -
- The ID of the virtual private gateway.
- |
+
+
+ + | +
+ The ID of the virtual private gateway.
+ |
|
| + | |||||
|
wait_timeout
integer
-
- |
-
- Default: 600
- |
-
- How long before wait gives up, in seconds.
- |
- |||
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
instance_id
string
- / required
- |
- - | -
- The instance id to get the password data from.
- |
+ / required
+
+ + | +
+ The instance id to get the password data from.
+ |
| + | ||||
|
key_data
string
-
- |
- - | -
- The private key (usually stored in vault).
- Conflicts with key_file,
- |
+
+
+ + | +
+ The private key (usually stored in vault).
+ Conflicts with key_file,
+ |
| + | ||||
|
key_file
path
-
- |
- - | -
- Path to the file containing the key pair used on the instance.
- Conflicts with key_data.
- |
+
+
+ + | +
+ Path to the file containing the key pair used on the instance.
+ Conflicts with key_data.
+ |
| + | ||||
|
key_passphrase
string
-
- |
- - | -
- The passphrase for the instance key pair. The key must use DES or 3DES encryption for this module to decrypt it. You can use openssl to convert your password protected keys if they do not use DES or 3DES. ex)
- openssl rsa -in current_key -out new_key -des3. |
+
+
+ + | +
+ The passphrase for the instance key pair. The key must use DES or 3DES encryption for this module to decrypt it. You can use openssl to convert your password protected keys if they do not use DES or 3DES. ex)
+ openssl rsa -in current_key -out new_key -des3. |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
wait
boolean
-
- |
-
-
|
-
- Whether or not to wait for the password to be available before returning.
- |
+
+
+
+
|
+
+ Whether or not to wait for the password to be available before returning.
+ |
| + | ||||
|
wait_timeout
integer
-
- |
-
- Default: 120
- |
-
- Number of seconds to wait before giving up.
- |
+
+
+
+ Default: 120
+ |
+
+ Number of seconds to wait before giving up.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
attributes
list
- / elements=dictionary / required
- |
- - | -
- List of attributes.
- |
+ / elements=dictionary / required
+
+ + | +
+ List of attributes.
+ |
|
| - | + | ||||
| + |
name
string
- / required
- |
- - | -
- The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.
- |
+ / required
+
+ + | +
+ The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.
+ |
| - | + | ||||
| + |
value
string
-
- |
- - | -
- The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.
- |
+
+
+ + | +
+ The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.
+ |
| + + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
cluster
string
- / required
- |
- - | -
- The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes.
- |
+ / required
+
+ + | +
+ The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes.
+ |
|
| + | |||||
|
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.
- |
+
+
+
+
|
+
+ 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_instance_id
string
- / required
- |
- - | -
- EC2 instance ID of ECS cluster container instance.
- |
+ / required
+
+ + | +
+ EC2 instance ID of ECS cluster container instance.
+ |
|
| + | |||||
|
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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
state
string
-
- |
-
-
|
-
- The desired state of the attributes.
- |
+
+
+
+
|
+
+ The desired state of the attributes.
+ |
|
| + | |||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
|
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
delay
integer
-
- |
-
- Default: 10
- |
-
- Number of seconds to wait.
- |
+
+
+
+ Default: 10
+ |
+
+ Number of seconds to wait.
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
name
string
- / required
- |
- - | -
- The cluster name.
- |
+ / required
+
+ + | +
+ The cluster name.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
repeat
integer
-
- |
-
- Default: 10
- |
-
- The number of times to wait for the cluster to have an instance.
- |
+
+
+
+ Default: 10
+ |
+
+ The number of times to wait for the cluster to have an instance.
+ |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
- / required
- |
-
-
|
-
- The desired state of the cluster.
- |
+ / required
+
+
+
|
+
+ The desired state of the cluster.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
force_set_policy
boolean
-
- |
-
-
|
-
- If force_set_policy=false, it prevents setting a policy that would prevent you from setting another policy in the future.
- |
+
+
+
+
|
+
+ If force_set_policy=false, it prevents setting a policy that would prevent you from setting another policy in the future.
+ |
| + | ||||
|
image_tag_mutability
string
-
- |
-
-
|
-
- Configure whether repository should be mutable (ie. an already existing tag can be overwritten) or not.
- |
+
+
+
+
|
+
+ Configure whether repository should be mutable (ie. an already existing tag can be overwritten) or not.
+ |
| + | ||||
|
lifecycle_policy
json
-
- |
- - | -
- JSON or dict that represents the new lifecycle policy
- |
+
+
+ + | +
+ JSON or dict that represents the new lifecycle policy
+ |
| + | ||||
|
name
string
- / required
- |
- - | -
- The name of the repository.
- |
+ / required
+
+ + | +
+ The name of the repository.
+ |
| + | ||||
|
policy
json
-
- |
- - | -
- JSON or dict that represents the new policy.
- |
+
+
+ + | +
+ JSON or dict that represents the new policy.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
purge_lifecycle_policy
boolean
-
- |
-
-
|
-
- if yes, remove the lifecycle policy from the repository
- |
+
+
+
+
|
+
+ if yes, remove the lifecycle policy from the repository
+ |
| + | ||||
|
purge_policy
boolean
-
- |
-
-
|
-
- If yes, remove the policy from the repository.
- Alias
- delete_policy has been deprecated and will be removed after 2022-06-01.aliases: delete_policy |
+
+
+
+
|
+
+ If yes, remove the policy from the repository.
+ Alias
+ delete_policy has been deprecated and will be removed after 2022-06-01.aliases: delete_policy |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
registry_id
string
-
- |
- - | -
- AWS account id associated with the registry.
- If not specified, the default registry is assumed.
- |
+
+
+ + | +
+ AWS account id associated with the registry.
+ If not specified, the default registry is assumed.
+ |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Create or destroy the repository.
- |
+
+
+
+
|
+
+ Create or destroy the repository.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
cluster
string
-
- |
- - | -
- The cluster ARNS in which to list the services.
- |
+
+
+ + | +
+ The cluster ARNS in which to list the services.
+ |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
details
boolean
-
- |
-
-
|
-
- Set this to true if you want detailed information about the services.
- |
+
+
+
+
|
+
+ Set this to true if you want detailed information about the services.
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
events
boolean
-
- |
-
-
|
-
- Whether to return ECS service events. Only has an effect if details=true.
- |
+
+
+
+
|
+
+ Whether to return ECS service events. Only has an effect if details=true.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
service
list
- / elements=string
- |
- - | -
- One or more services to get details for
- |
+ / elements=string
+
+ + | +
+ One or more services to get details for
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
client_token
string
-
- |
- - | -
- Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
- |
+
+
+ + | +
+ Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
+ |
|
| + | |||||
|
cluster
string
-
- |
- - | -
- The name of the cluster in which the service exists.
- |
+
+
+ + | +
+ The name of the cluster in which the service exists.
+ |
|
| + | |||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
|
| + | |||||
|
delay
integer
-
- |
-
- Default: 10
- |
-
- The time to wait before checking that the service is available.
- |
+
+
+
+ Default: 10
+ |
+
+ The time to wait before checking that the service is available.
+ |
|
| + | |||||
|
deployment_configuration
dictionary
-
- |
- - | -
- Optional parameters that control the deployment_configuration.
- Format is '{"maximum_percent":<integer>, "minimum_healthy_percent":<integer>}
- |
- |||
| - | + + | ++ | +
+ Optional parameters that control the deployment_configuration.
+ Format is '{"maximum_percent":<integer>, "minimum_healthy_percent":<integer>}
+ |
+ ||
| + |
maximum_percent
integer
-
- |
- - | -
- Upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment.
- |
+
+
+ + | +
+ Upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment.
+ |
| - | + | ||||
| + |
minimum_healthy_percent
integer
-
- |
- - | -
- A lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment.
- |
- ||
| + + | ++ | +
+ A lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment.
+ |
+ |||
|
desired_count
integer
-
- |
- - | -
- The count of how many instances of the service.
- This parameter is required when state=present.
- |
+
+
+ + | +
+ The count of how many instances of the service.
+ This parameter is required when state=present.
+ |
|
| + | |||||
|
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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
force_new_deployment
boolean
-
- |
-
-
|
-
- Force deployment of service even if there are no changes.
- |
+
+
+
+
|
+
+ Force deployment of service even if there are no changes.
+ |
|
| + | |||||
|
health_check_grace_period_seconds
integer
-
- |
- - | -
- Seconds to wait before health checking the freshly added/updated services.
- This option requires botocore >= 1.8.20.
- |
+
+
+ + | +
+ Seconds to wait before health checking the freshly added/updated services.
+ This option requires botocore >= 1.8.20.
+ |
|
| + | |||||
|
launch_type
string
-
- |
-
-
|
-
- The launch type on which to run your service.
- |
+
+
+
+
|
+
+ The launch type on which to run your service.
+ |
|
| + | |||||
|
load_balancers
list
- / elements=string
- |
- - | -
- The list of ELBs defined for this service.
- |
+ / elements=string
+
+ + | +
+ The list of ELBs defined for this service.
+ |
|
| + | |||||
|
name
string
- / required
- |
- - | -
- The name of the service.
- |
+ / required
+
+ + | +
+ The name of the service.
+ |
|
| + | |||||
|
network_configuration
dictionary
-
- |
- - | -
- Network configuration of the service. Only applicable for task definitions created with network_mode=awsvpc.
- assign_public_ip requires botocore >= 1.8.4
- |
- |||
| - | + + | ++ | +
+ Network configuration of the service. Only applicable for task definitions created with network_mode=awsvpc.
+ assign_public_ip requires botocore >= 1.8.4
+ |
+ ||
| + |
assign_public_ip
boolean
-
- |
-
-
|
-
- Whether the task's elastic network interface receives a public IP address.
- This option requires botocore >= 1.8.4.
- |
+
+
+
+
|
+
+ Whether the task's elastic network interface receives a public IP address.
+ This option requires botocore >= 1.8.4.
+ |
| - | + | ||||
| + |
security_groups
list
- / elements=string
- |
- - | -
- A list of security group names or group IDs to associate with the task
- |
+ / elements=string
+
+ + | +
+ A list of security group names or group IDs to associate with the task
+ |
| - | + | ||||
| + |
subnets
list
- / elements=string
- |
- - | -
- A list of subnet IDs to associate with the task
- |
- ||
| + / elements=string + | ++ | +
+ A list of subnet IDs to associate with the task
+ |
+ |||
|
placement_constraints
list
- / elements=dictionary
- |
- - | -
- The placement constraints for the tasks in the service.
- See https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PlacementConstraint.html for more details.
- |
- |||
| - | + / elements=dictionary + | ++ | +
+ The placement constraints for the tasks in the service.
+ See https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PlacementConstraint.html for more details.
+ |
+ ||
| + |
expression
string
-
- |
- - | -
- A cluster query language expression to apply to the constraint.
- |
+
+
+ + | +
+ A cluster query language expression to apply to the constraint.
+ |
| - | + | ||||
| + |
type
string
-
- |
- - | -
- The type of constraint.
- |
- ||
| + + | ++ | +
+ The type of constraint.
+ |
+ |||
|
placement_strategy
list
- / elements=dictionary
- |
- - | -
- The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules per service.
- |
- |||
| - | + / elements=dictionary + | ++ | +
+ The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules per service.
+ |
+ ||
| + |
field
string
-
- |
- - | -
- The field to apply the placement strategy against.
- |
+
+
+ + | +
+ The field to apply the placement strategy against.
+ |
| - | + | ||||
| + |
type
string
-
- |
- - | -
- The type of placement strategy.
- |
- ||
| + + | ++ | +
+ The type of placement strategy.
+ |
+ |||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
repeat
integer
-
- |
-
- Default: 10
- |
-
- The number of times to check that the service is available.
- |
+
+
+
+ Default: 10
+ |
+
+ The number of times to check that the service is available.
+ |
|
| + | |||||
|
role
string
-
- |
- - | -
- The name or full Amazon Resource Name (ARN) of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf.
- This parameter is only required if you are using a load balancer with your service in a network mode other than
- awsvpc. |
+
+
+ + | +
+ The name or full Amazon Resource Name (ARN) of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf.
+ This parameter is only required if you are using a load balancer with your service in a network mode other than
+ awsvpc. |
|
| + | |||||
|
scheduling_strategy
string
-
- |
-
-
|
-
- The scheduling strategy, defaults to "REPLICA" if not given to preserve previous behavior
- |
+
+
+
+
|
+
+ The scheduling strategy, defaults to "REPLICA" if not given to preserve previous behavior
+ |
|
| + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
service_registries
list
- / elements=dictionary
- |
- - | -
- Describes service discovery registries this service will register with.
- |
- |||
| - | + / elements=dictionary + | ++ | +
+ Describes service discovery registries this service will register with.
+ |
+ ||
| + |
arn
string
-
- |
- - | -
- Service discovery registry ARN
- |
+
+
+ + | +
+ Service discovery registry ARN
+ |
| - | + | ||||
| + |
container_name
string
-
- |
- - | -
- container name for service discovery registration
- |
+
+
+ + | +
+ container name for service discovery registration
+ |
| - | + | ||||
| + |
container_port
integer
-
- |
- - | -
- container port for service discovery registration
- |
- ||
| + + | ++ | +
+ container port for service discovery registration
+ |
+ |||
|
state
string
- / required
- |
-
-
|
-
- The desired state of the service.
- |
+ / required
+
+
+
|
+
+ The desired state of the service.
+ |
|
| + | |||||
|
task_definition
string
-
- |
- - | -
- The task definition the service will run.
- This parameter is required when state=present.
- |
+
+
+ + | +
+ The task definition the service will run.
+ This parameter is required when state=present.
+ |
|
| + | |||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
- |||
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
cluster_name
string
- / required
- |
- - | -
- The name of the cluster whose resources we are tagging.
- |
+ / required
+
+ + | +
+ The name of the cluster whose resources we are tagging.
+ |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
purge_tags
boolean
-
- |
-
-
|
-
- Whether unspecified tags should be removed from the resource.
- Note that when combined with state=absent, specified tags with non-matching values are not purged.
- |
+
+
+
+
|
+
+ Whether unspecified tags should be removed from the resource.
+ Note that when combined with state=absent, specified tags with non-matching values are not purged.
+ |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
resource
string
-
- |
- - | -
- The ECS resource name.
- Required unless resource_type=cluster.
- |
+
+
+ + | +
+ The ECS resource name.
+ Required unless resource_type=cluster.
+ |
| + | ||||
|
resource_type
string
-
- |
-
-
|
-
- The type of resource.
- |
+
+
+
+
|
+
+ The type of resource.
+ |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
-
- |
-
-
|
-
- Whether the tags should be present or absent on the resource.
- |
+
+
+
+
|
+
+ Whether the tags should be present or absent on the resource.
+ |
| + | ||||
|
tags
dictionary
-
- |
- - | -
- A dictionary of tags to add or remove from the resource.
- If the value provided for a tag is null and state=absent, the tag will be removed regardless of its current value.
- |
+
+
+ + | +
+ A dictionary of tags to add or remove from the resource.
+ If the value provided for a tag is null and state=absent, the tag will be removed regardless of its current value.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
cluster
string
-
- |
- - | -
- The name of the cluster to run the task on.
- |
+
+
+ + | +
+ The name of the cluster to run the task on.
+ |
|
| + | |||||
|
container_instances
list
- / elements=string
- |
- - | -
- The list of container instances on which to deploy the task.
- |
+ / elements=string
+
+ + | +
+ The list of container instances on which to deploy the task.
+ |
|
| + | |||||
|
count
integer
-
- |
- - | -
- How many new instances to start.
- |
+
+
+ + | +
+ How many new instances to start.
+ |
|
| + | |||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
launch_type
string
-
- |
-
-
|
-
- The launch type on which to run your service.
- |
+
+
+
+
|
+
+ The launch type on which to run your service.
+ |
|
| + | |||||
|
network_configuration
dictionary
-
- |
- - | -
- Network configuration of the service. Only applicable for task definitions created with network_mode=awsvpc.
- |
- |||
| - | + + | ++ | +
+ Network configuration of the service. Only applicable for task definitions created with network_mode=awsvpc.
+ |
+ ||
| + |
security_groups
list
- / elements=string
- |
- - | -
- A list of group names or group IDs for the task.
- |
+ / elements=string
+
+ + | +
+ A list of group names or group IDs for the task.
+ |
| - | + | ||||
| + |
subnets
list
- / elements=string
- |
- - | -
- A list of subnet IDs to which the task is attached.
- |
- ||
| + / elements=string + | ++ | +
+ A list of subnet IDs to which the task is attached.
+ |
+ |||
|
operation
string
- / required
- |
-
-
|
-
- Which task operation to execute.
- |
+ / required
+
+
+
|
+
+ Which task operation to execute.
+ |
|
| + | |||||
|
overrides
dictionary
-
- |
- - | -
- A dictionary of values to pass to the new instances.
- |
+
+
+ + | +
+ A dictionary of values to pass to the new instances.
+ |
|
| + | |||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
started_by
string
-
- |
- - | -
- A value showing who or what started the task (for informational purposes).
- |
+
+
+ + | +
+ A value showing who or what started the task (for informational purposes).
+ |
|
| + | |||||
|
tags
dictionary
-
- |
- - | -
- Tags that will be added to ecs tasks on start and run
- |
+
+
+ + | +
+ Tags that will be added to ecs tasks on start and run
+ |
|
| + | |||||
|
task
string
-
- |
- - | -
- The task to stop.
- |
+
+
+ + | +
+ The task to stop.
+ |
|
| + | |||||
|
task_definition
string
-
- |
- - | -
- The task definition to start or run.
- |
+
+
+ + | +
+ The task definition to start or run.
+ |
|
| + | |||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
- |||
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
task_definition
string
- / required
- |
- - | -
- The name of the task definition to get details for
- |
+ / required
+
+ + | +
+ The name of the task definition to get details for
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
-
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
arn
string
-
- |
- - | -
- The ARN of the task description to delete.
- |
+
+
+ + | +
+ The ARN of the task description to delete.
+ |
|
| + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
containers
list
- / elements=string
- |
- - | -
- A list of containers definitions.
- |
+ / elements=string
+
+ + | +
+ A list of containers definitions.
+ |
|
| + | |||||
|
cpu
string
-
- |
- - | -
- The number of cpu units used by the task. If using the EC2 launch type, this field is optional and any value can be used.
- If using the Fargate launch type, this field is required and you must use one of
- 256, 512, 1024, 2048, 4096. |
+
+
+ + | +
+ The number of cpu units used by the task. If using the EC2 launch type, this field is optional and any value can be used.
+ If using the Fargate launch type, this field is required and you must use one of
+ 256, 512, 1024, 2048, 4096. |
|
| + | |||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
execution_role_arn
string
-
- |
- - | -
- The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
- |
+
+
+ + | +
+ The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
+ |
|
| + | |||||
|
family
string
-
- |
- - | -
- A Name that would be given to the task definition.
- |
+
+
+ + | +
+ A Name that would be given to the task definition.
+ |
|
| + | |||||
|
force_create
boolean
-
- |
-
-
|
-
- Always create new task definition.
- |
+
+
+
+
|
+
+ Always create new task definition.
+ |
|
| + | |||||
|
launch_type
string
-
- |
-
-
|
-
- The launch type on which to run your task.
- |
+
+
+
+
|
+
+ The launch type on which to run your task.
+ |
|
| + | |||||
|
memory
string
-
- |
- - | -
- The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used.
- If using the Fargate launch type, this field is required and is limited by the cpu.
- |
+
+
+ + | +
+ The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used.
+ If using the Fargate launch type, this field is required and is limited by the cpu.
+ |
|
| + | |||||
|
network_mode
string
-
- |
-
-
|
-
- The Docker networking mode to use for the containers in the task.
- awsvpc mode was added in Ansible 2.5Windows containers must use network_mode=default, which will utilize docker NAT networking.
- Setting network_mode=default for a Linux container will use bridge mode.
- |
+
+
+
+
|
+
+ The Docker networking mode to use for the containers in the task.
+ awsvpc mode was added in Ansible 2.5Windows containers must use network_mode=default, which will utilize docker NAT networking.
+ Setting network_mode=default for a Linux container will use bridge mode.
+ |
|
| + | |||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
revision
integer
-
- |
- - | -
- A revision number for the task definition.
- |
+
+
+ + | +
+ A revision number for the task definition.
+ |
|
| + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
state
string
- / required
- |
-
-
|
-
- State whether the task definition should exist or be deleted.
- |
+ / required
+
+
+
|
+
+ State whether the task definition should exist or be deleted.
+ |
|
| + | |||||
|
task_role_arn
string
-
- |
- - | -
- The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
- |
+
+
+ + | +
+ The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
+ |
|
| + | |||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
|
| + | |||||
|
volumes
list
- / elements=dictionary
- |
- - | -
- A list of names of volumes to be attached.
- |
+ / elements=dictionary
+
+ + | +
+ A list of names of volumes to be attached.
+ |
|
| - | + | ||||
| + |
name
string
- / required
- |
- - | -
- The name of the volume.
- |
+ / required
+
+ + | +
+ The name of the volume.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
id
string
-
- |
- - | -
- ID of Amazon EFS.
- |
+
+
+ + | +
+ ID of Amazon EFS.
+ |
| + | ||||
|
name
string
-
- |
- - | -
- Creation Token of Amazon EFS file system.
- aliases: creation_token |
+
+
+ + | +
+ Creation Token of Amazon EFS file system.
+ aliases: creation_token |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
tags
dictionary
-
- |
- - | -
- List of tags of Amazon EFS. Should be defined as dictionary.
- |
+
+
+ + | +
+ List of tags of Amazon EFS. Should be defined as dictionary.
+ |
| + | ||||
|
targets
list
- / elements=string
- |
- - | -
- List of targets on which to filter the returned results.
- Result must match all of the specified targets, each of which can be a security group ID, a subnet ID or an IP address.
- |
+ / elements=string
+
+ + | +
+ List of targets on which to filter the returned results.
+ Result must match all of the specified targets, each of which can be a security group ID, a subnet ID or an IP address.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | ||
|---|---|---|---|---|---|
| + | |||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
|
| + | |||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
|
| + | |||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
encrypt
boolean
-
- |
-
-
|
-
- If encrypt=true creates an encrypted file system. This can not be modified after the file system is created.
- |
+
+
+
+
|
+
+ If encrypt=true creates an encrypted file system. This can not be modified after the file system is created.
+ |
|
| + | |||||
|
id
string
-
- |
- - | -
- ID of Amazon EFS. Either name or ID required for delete.
- |
+
+
+ + | +
+ ID of Amazon EFS. Either name or ID required for delete.
+ |
|
| + | |||||
|
kms_key_id
string
-
- |
- - | -
- The id of the AWS KMS CMK that will be used to protect the encrypted file system. This parameter is only required if you want to use a non-default CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. The key id can be Key ID, Key ID ARN, Key Alias or Key Alias ARN.
- |
+
+
+ + | +
+ The id of the AWS KMS CMK that will be used to protect the encrypted file system. This parameter is only required if you want to use a non-default CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. The key id can be Key ID, Key ID ARN, Key Alias or Key Alias ARN.
+ |
|
| + | |||||
|
name
string
-
- |
- - | -
- Creation Token of Amazon EFS file system. Required for create and update. Either name or ID required for delete.
- |
+
+
+ + | +
+ Creation Token of Amazon EFS file system. Required for create and update. Either name or ID required for delete.
+ |
|
| + | |||||
|
performance_mode
string
-
- |
-
-
|
-
- File system's performance mode to use. Only takes effect during creation.
- |
+
+
+
+
|
+
+ File system's performance mode to use. Only takes effect during creation.
+ |
|
| + | |||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
|
| + | |||||
|
provisioned_throughput_in_mibps
float
-
- |
- - | -
- If the throughput_mode is provisioned, select the amount of throughput to provisioned in Mibps.
- Requires botocore >= 1.10.57
- |
+
+
+ + | +
+ If the throughput_mode is provisioned, select the amount of throughput to provisioned in Mibps.
+ Requires botocore >= 1.10.57
+ |
|
| + | |||||
|
purge_tags
boolean
-
- |
-
-
|
-
- If yes, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified.
- |
+
+
+
+
|
+
+ If yes, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified.
+ |
|
| + | |||||
|
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 |
+
+
+ + | +
+ 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 |
|
| + | |||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
|
| + | |||||
|
state
string
-
- |
-
-
|
-
- Allows to create, search and destroy Amazon EFS file system.
- |
+
+
+
+
|
+
+ Allows to create, search and destroy Amazon EFS file system.
+ |
|
| + | |||||
|
tags
dictionary
-
- |
- - | -
- List of tags of Amazon EFS. Should be defined as dictionary In case of 'present' state with list of tags and existing EFS (matched by 'name'), tags of EFS will be replaced with provided data.
- |
+
+
+ + | +
+ List of tags of Amazon EFS. Should be defined as dictionary In case of 'present' state with list of tags and existing EFS (matched by 'name'), tags of EFS will be replaced with provided data.
+ |
|
| + | |||||
|
targets
list
- / elements=dictionary
- |
- - | -
- List of mounted targets. It should be a list of dictionaries, every dictionary should include next attributes: This data may be modified for existing EFS using state 'present' and new list of mount targets.
- |
- |||
| - | + / elements=dictionary + | ++ | +
+ List of mounted targets. It should be a list of dictionaries, every dictionary should include next attributes: This data may be modified for existing EFS using state 'present' and new list of mount targets.
+ |
+ ||
| + |
ip_address
string
-
- |
- - | -
- A valid IPv4 address within the address range of the specified subnet.
- |
+
+
+ + | +
+ A valid IPv4 address within the address range of the specified subnet.
+ |
| - | + | ||||
| + |
security_groups
list
- / elements=string
- |
- - | -
- List of security group IDs, of the form 'sg-xxxxxxxx'. These must be for the same VPC as subnet specified
- |
+ / elements=string
+
+ + | +
+ List of security group IDs, of the form 'sg-xxxxxxxx'. These must be for the same VPC as subnet specified
+ |
| - | + | ||||
| + |
subnet_id
-
- / required
- |
- - | -
- The ID of the subnet to add the mount target in.
- |
- ||
| + / required + | ++ | +
+ The ID of the subnet to add the mount target in.
+ |
+ |||
|
throughput_mode
string
-
- |
-
-
|
-
- The throughput_mode for the file system to be created.
- Requires botocore >= 1.10.57
- |
+
+
+
+
|
+
+ The throughput_mode for the file system to be created.
+ Requires botocore >= 1.10.57
+ |
|
| + | |||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
|
| + | |||||
|
wait
boolean
-
- |
-
-
|
-
- In case of 'present' state should wait for EFS 'available' life cycle state (of course, if current state not 'deleting' or 'deleted') In case of 'absent' state should wait for EFS 'deleted' life cycle state
- |
+
+
+
+
|
+
+ In case of 'present' state should wait for EFS 'available' life cycle state (of course, if current state not 'deleting' or 'deleted') In case of 'absent' state should wait for EFS 'deleted' life cycle state
+ |
|
| + | |||||
|
wait_timeout
integer
-
- |
-
- Default: 0
- |
-
- How long the module should wait (in seconds) for desired state before returning. Zero means wait as long as necessary.
- |
- |||
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
name
string
-
- |
- - | -
- The name of an ElastiCache cluster.
- |
+
+
+ + | +
+ The name of an ElastiCache cluster.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
-
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
cache_engine_version
string
-
- |
- - | -
- The version number of the cache engine.
- |
+
+
+ + | +
+ The version number of the cache engine.
+ |
| + | ||||
|
cache_parameter_group
string
-
- |
- - | -
- The name of the cache parameter group to associate with this cache cluster. If this argument is omitted, the default cache parameter group for the specified engine will be used.
- aliases: parameter_group |
+
+
+ + | +
+ The name of the cache parameter group to associate with this cache cluster. If this argument is omitted, the default cache parameter group for the specified engine will be used.
+ aliases: parameter_group |
| + | ||||
|
cache_port
integer
-
- |
- - | -
- The port number on which each of the cache nodes will accept connections.
- |
+
+
+ + | +
+ The port number on which each of the cache nodes will accept connections.
+ |
| + | ||||
|
cache_security_groups
list
- / elements=string
- |
- - | -
- A list of cache security group names to associate with this cache cluster. Must be an empty list if inside a vpc.
- |
+ / elements=string
+
+ + | +
+ A list of cache security group names to associate with this cache cluster. Must be an empty list if inside a vpc.
+ |
| + | ||||
|
cache_subnet_group
string
-
- |
- - | -
- The subnet group name to associate with. Only use if inside a vpc.
- Required if inside a vpc
- |
+
+
+ + | +
+ The subnet group name to associate with. Only use if inside a vpc.
+ Required if inside a vpc
+ |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
engine
string
-
- |
-
- Default: "memcached"
- |
-
- Name of the cache engine to be used.
- Supported values are
- redis and memcached. |
+
+
+
+ Default: "memcached"
+ |
+
+ Name of the cache engine to be used.
+ Supported values are
+ redis and memcached. |
| + | ||||
|
hard_modify
boolean
-
- |
-
-
|
-
- Whether to destroy and recreate an existing cache cluster if necessary in order to modify its state.
- |
+
+
+
+
|
+
+ Whether to destroy and recreate an existing cache cluster if necessary in order to modify its state.
+ |
| + | ||||
|
name
string
- / required
- |
- - | -
- The cache cluster identifier.
- |
+ / required
+
+ + | +
+ The cache cluster identifier.
+ |
| + | ||||
|
node_type
string
-
- |
-
- Default: "cache.t2.small"
- |
-
- The compute and memory capacity of the nodes in the cache cluster.
- |
+
+
+
+ Default: "cache.t2.small"
+ |
+
+ The compute and memory capacity of the nodes in the cache cluster.
+ |
| + | ||||
|
num_nodes
integer
-
- |
-
- Default: 1
- |
-
- The initial number of cache nodes that the cache cluster will have.
- Required when state=present.
- |
+
+
+
+ Default: 1
+ |
+
+ The initial number of cache nodes that the cache cluster will have.
+ Required when state=present.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
security_group_ids
list
- / elements=string
- |
- - | -
- A list of vpc security group IDs to associate with this cache cluster. Only use if inside a vpc.
- |
+ / elements=string
+
+ + | +
+ A list of vpc security group IDs to associate with this cache cluster. Only use if inside a vpc.
+ |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
- / required
- |
-
-
|
-
- absent or present are idempotent actions that will create or destroy a cache cluster as needed.rebooted will reboot the cluster, resulting in a momentary outage. |
+ / required
+
+
+
|
+
+ absent or present are idempotent actions that will create or destroy a cache cluster as needed.rebooted will reboot the cluster, resulting in a momentary outage. |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
wait
boolean
-
- |
-
-
|
-
- Wait for cache cluster result before returning.
- |
+
+
+
+
|
+
+ Wait for cache cluster result before returning.
+ |
| + | ||||
|
zone
string
-
- |
- - | -
- The EC2 Availability Zone in which the cache cluster will be created.
- |
+
+
+ + | +
+ The EC2 Availability Zone in which the cache cluster will be created.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
description
string
-
- |
- - | -
- A user-specified description for the cache parameter group.
- |
+
+
+ + | +
+ A user-specified description for the cache parameter group.
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
group_family
string
-
- |
-
-
|
-
- The name of the cache parameter group family that the cache parameter group can be used with. Required when creating a cache parameter group.
- |
+
+
+
+
|
+
+ The name of the cache parameter group family that the cache parameter group can be used with. Required when creating a cache parameter group.
+ |
| + | ||||
|
name
string
- / required
- |
- - | -
- A user-specified name for the cache parameter group.
- |
+ / required
+
+ + | +
+ A user-specified name for the cache parameter group.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
- / required
- |
-
-
|
-
- Idempotent actions that will create/modify, destroy, or reset a cache parameter group as needed.
- |
+ / required
+
+
+
|
+
+ Idempotent actions that will create/modify, destroy, or reset a cache parameter group as needed.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
values
dictionary
-
- |
- - | -
- A user-specified dictionary of parameters to reset or modify for the cache parameter group.
- |
+
+
+ + | +
+ A user-specified dictionary of parameters to reset or modify for the cache parameter group.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
bucket
string
-
- |
- - | -
- The s3 bucket to which the snapshot is exported.
- |
+
+
+ + | +
+ The s3 bucket to which the snapshot is exported.
+ |
| + | ||||
|
cluster_id
string
-
- |
- - | -
- The name of an existing cache cluster in the replication group to make the snapshot.
- |
+
+
+ + | +
+ The name of an existing cache cluster in the replication group to make the snapshot.
+ |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
name
string
- / required
- |
- - | -
- The name of the snapshot we want to create, copy, delete.
- |
+ / required
+
+ + | +
+ The name of the snapshot we want to create, copy, delete.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
replication_id
string
-
- |
- - | -
- The name of the existing replication group to make the snapshot.
- |
+
+
+ + | +
+ The name of the existing replication group to make the snapshot.
+ |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
- / required
- |
-
-
|
-
- Actions that will create, destroy, or copy a snapshot.
- |
+ / required
+
+
+
|
+
+ Actions that will create, destroy, or copy a snapshot.
+ |
| + | ||||
|
target
string
-
- |
- - | -
- The name of a snapshot copy.
- |
+
+
+ + | +
+ The name of a snapshot copy.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
description
string
-
- |
- - | -
- ElastiCache subnet group description. Only set when a new group is added.
- |
+
+
+ + | +
+ ElastiCache subnet group description. Only set when a new group is added.
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
name
string
- / required
- |
- - | -
- Database subnet group identifier.
- |
+ / required
+
+ + | +
+ Database subnet group identifier.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
- / required
- |
-
-
|
-
- Specifies whether the subnet should be present or absent.
- |
+ / required
+
+
+
|
+
+ Specifies whether the subnet should be present or absent.
+ |
| + | ||||
|
subnets
list
- / elements=string
- |
- - | -
- List of subnet IDs that make up the ElastiCache subnet group.
- |
+ / elements=string
+
+ + | +
+ List of subnet IDs that make up the ElastiCache subnet group.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
load_balancer_arns
list
-
- |
- - | -
- The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.
- |
+ / elements=string
+
+ + | +
+ The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.
+ |
| + | ||||
|
names
list
-
- |
- - | -
- The names of the load balancers.
- |
+ / elements=string
+
+ + | +
+ The names of the load balancers.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |||
|---|---|---|---|---|---|---|
| + | ||||||
|
access_logs_enabled
boolean
-
- |
-
-
|
-
- Whether or not to enable access logs.
- When set, access_logs_s3_bucket must also be set.
- |
+
+
+
+
|
+
+ Whether or not to enable access logs.
+ When set, access_logs_s3_bucket must also be set.
+ |
||
| + | ||||||
|
access_logs_s3_bucket
string
-
- |
- - | -
- The name of the S3 bucket for the access logs.
- 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.
- Required if access logs in Amazon S3 are enabled.
- When set, access_logs_enabled must also be set.
- |
- ||||
| + + | ++ | +
+ The name of the S3 bucket for the access logs.
+ 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.
+ Required if access logs in Amazon S3 are enabled.
+ When set, access_logs_enabled must also be set.
+ |
+ ||||
|
access_logs_s3_prefix
string
-
- |
- - | -
- The prefix for the log location in the S3 bucket.
- If you don't specify a prefix, the access logs are stored in the root of the bucket.
- Cannot begin or end with a slash.
- |
+
+
+ + | +
+ The prefix for the log location in the S3 bucket.
+ If you don't specify a prefix, the access logs are stored in the root of the bucket.
+ Cannot begin or end with a slash.
+ |
||
| + | ||||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
||
| + | ||||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
||
| + | ||||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
||
| + | ||||||
|
deletion_protection
boolean
-
- |
-
-
|
-
- Indicates whether deletion protection for the ELB is enabled.
- |
+
+
+
+
|
+
+ Indicates whether deletion protection for the ELB is enabled.
+ |
||
| + | ||||||
|
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.
- |
+
+
+ + | +
+ 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 |
||
| + | ||||||
|
http2
boolean
-
- |
-
-
|
-
- Indicates whether to enable HTTP2 routing.
- |
+
+
+
+
|
+
+ Indicates whether to enable HTTP2 routing.
+ |
||
| + | ||||||
|
idle_timeout
integer
-
- |
- - | -
- The number of seconds to wait before an idle connection is closed.
- |
+
+
+ + | +
+ The number of seconds to wait before an idle connection is closed.
+ |
||
| + | ||||||
|
listeners
list
-
- |
- - | -
- 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.
- |
- ||||
| - | + / elements=dictionary + | ++ | +
+ 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.
+ |
+ |||
| + |
Certificates
list
-
- |
- - | -
- The SSL server certificate.
- |
- |||
| - | - | + / elements=dictionary + | ++ | +
+ The SSL server certificate.
+ |
+ ||
| + | + |
CertificateArn
string
-
- |
- - | -
- The Amazon Resource Name (ARN) of the certificate.
- |
- ||
| - | + + | ++ | +
+ The Amazon Resource Name (ARN) of the certificate.
+ |
+ |||
| + |
DefaultActions
list
- / required
- |
- - | -
- The default actions for the listener.
- |
- |||
| - | - | + / elements=dictionary / required + | ++ | +
+ The default actions for the listener.
+ |
+ ||
| + | + |
TargetGroupArn
string
-
- |
- - | -
- The Amazon Resource Name (ARN) of the target group.
- |
+
+
+ + | +
+ The Amazon Resource Name (ARN) of the target group.
+ |
| - | - | + | ||||
| + | + |
Type
string
-
- |
- - | -
- The type of action.
- |
- ||
| - | + + | ++ | +
+ The type of action.
+ |
+ |||
| + |
Port
integer
- / required
- |
- - | -
- The port on which the load balancer is listening.
- |
+ / required
+
+ + | +
+ The port on which the load balancer is listening.
+ |
|
| - | + | |||||
| + |
Protocol
string
- / required
- |
- - | -
- The protocol for connections from clients to the load balancer.
- |
+ / required
+
+ + | +
+ The protocol for connections from clients to the load balancer.
+ |
|
| - | + | |||||
| + |
Rules
list
-
- |
- - | -
- A list of ALB Listener Rules.
- For the complete documentation of possible Conditions and Actions please see the boto3 documentation:
- https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/elbv2.html#ElasticLoadBalancingv2.Client.create_rule
- |
- |||
| - | - | + / elements=dictionary + | ++ | +
+ A list of ALB Listener Rules.
+ For the complete documentation of possible Conditions and Actions please see the boto3 documentation:
+ https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/elbv2.html#ElasticLoadBalancingv2.Client.create_rule
+ |
+ ||
| + | + |
Actions
list
-
- |
- - | -
- Actions to apply if all of the rule's conditions are met.
- |
+
+
+ + | +
+ Actions to apply if all of the rule's conditions are met.
+ |
| - | - | + | ||||
| + | + |
Conditions
list
-
- |
- - | -
- Conditions which must be met for the actions to be applied.
- |
+
+
+ + | +
+ Conditions which must be met for the actions to be applied.
+ |
| - | - | + | ||||
| + | + |
Priority
integer
-
- |
- - | -
- The rule priority.
- |
- ||
| - | + + | ++ | +
+ The rule priority.
+ |
+ |||
| + |
SslPolicy
string
-
- |
- - | -
- The security policy that defines which ciphers and protocols are supported.
- |
- |||
| + + | ++ | +
+ The security policy that defines which ciphers and protocols are supported.
+ |
+ ||||
|
name
string
- / required
- |
- - | -
- 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.
- |
+ / required
+
+ + | +
+ 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.
+ |
||
| + | ||||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
||
| + | ||||||
|
purge_listeners
boolean
-
- |
-
-
|
-
- If yes, existing listeners will be purged from the ELB to match exactly what is defined by listeners parameter. If the listeners parameter is not set then listeners will not be modified
- |
+
+
+
+
|
+
+ If yes, existing listeners will be purged from the ELB to match exactly what is defined by listeners parameter. If the listeners parameter is not set then listeners will not be modified
+ |
||
| + | ||||||
|
purge_rules
boolean
-
- |
-
-
|
-
- When set to no, keep the existing load balancer rules in place. Will modify and add, but will not delete.
- |
+
+
+
+
|
+
+ When set to no, keep the existing load balancer rules in place. Will modify and add, but will not delete.
+ |
||
| + | ||||||
|
purge_tags
boolean
-
- |
-
-
|
-
- If yes, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified.
- |
+
+
+
+
|
+
+ If yes, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified.
+ |
||
| + | ||||||
|
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 |
+
+
+ + | +
+ 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
-
- |
-
-
|
-
- Internet-facing or internal load balancer. An ELB scheme can not be modified after creation.
- |
+
+
+
+
|
+
+ Internet-facing or internal load balancer. An ELB scheme can not be modified after creation.
+ |
||
| + | ||||||
|
security_groups
list
-
- |
-
- Default: []
- |
-
- A list of the names or IDs of the security groups to assign to the load balancer.
- Required if state=present.
- |
+ / elements=string
+
+
+ Default: []
+ |
+
+ A list of the names or IDs of the security groups to assign to the load balancer.
+ Required if state=present.
+ |
||
| + | ||||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
||
| + | ||||||
|
state
string
-
- |
-
-
|
-
- Create or destroy the load balancer.
- |
+
+
+
+
|
+
+ Create or destroy the load balancer.
+ |
||
| + | ||||||
|
subnets
list
-
- |
- - | -
- 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.
- |
+ / elements=string
+
+ + | +
+ 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.
+ |
||
| + | ||||||
|
tags
dictionary
-
- |
- - | -
- A dictionary of one or more tags to assign to the load balancer.
- |
+
+
+ + | +
+ A dictionary of one or more tags to assign to the load balancer.
+ |
||
| + | ||||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
||
| + | ||||||
|
wait
boolean
-
- |
-
-
|
-
- 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.
- |
+
+
+
+
|
+
+ 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.
+ |
||
| + | ||||||
|
wait_timeout
integer
-
- |
- - | -
- The time in seconds to use in conjunction with wait.
- |
- ||||
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
names
list
-
- |
- - | -
- List of ELB names to gather information about. Pass this option to gather information about a set of ELBs, otherwise, all ELBs are returned.
- |
+ / elements=string
+
+ + | +
+ List of ELB names to gather information about. Pass this option to gather information about a set of ELBs, otherwise, all ELBs are returned.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
access_logs
dictionary
-
- |
- - | -
- An associative array of access logs configuration settings (see example)
- |
+
+
+ + | +
+ An associative array of access logs configuration settings (see example)
+ |
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
- ||
| + + | ++ | +
+ 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.
+ aliases: ec2_access_key, access_key |
+ ||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
- ||
| + + | ++ | +
+ 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.
- aliases: ec2_secret_key, secret_key |
- ||
| + + | ++ | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
+ ||
|
connection_draining_timeout
integer
-
- |
- - | -
- Wait a specified timeout allowing connections to drain before terminating an instance
- |
+
+
+ + | +
+ Wait a specified timeout allowing connections to drain before terminating an instance
+ |
| + | ||||
|
cross_az_load_balancing
boolean
-
- |
-
-
|
-
- Distribute load across all configured Availability Zones
- |
- ||
| + + | +
+
|
+
+ Distribute load across all configured Availability Zones
+ |
+ ||
|
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.
- |
- ||
| + + | +
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 example)
- |
+
+
+ + | +
+ An associative array of health check configuration settings (see example)
+ |
| + | ||||
|
idle_timeout
integer
-
- |
- - | -
- ELB connections from clients and to servers are timed out after this amount of time
- |
+
+
+ + | +
+ ELB connections from clients and to servers are timed out after this amount of time
+ |
| + | ||||
|
instance_ids
list
-
- |
- - | -
- List of instance ids to attach to this ELB
- |
+ / elements=string
+
+ + | +
+ List of instance ids to attach to this ELB
+ |
| + | ||||
|
listeners
list
-
- |
- - | -
- List of ports/protocols for this ELB to listen on (see example)
- |
+ / elements=dictionary
+
+ + | +
+ List of ports/protocols for this ELB to listen on (see example)
+ |
| + | ||||
|
name
string
- / required
- |
- - | -
- The name of the ELB
- |
+ / required
+
+ + | +
+ The name of the ELB
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
purge_instance_ids
boolean
-
- |
-
-
|
-
- Purge existing instance ids on ELB that are not found in instance_ids
- |
- ||
| + + | +
+
|
+
+ 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 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 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
- |
- ||
| + + | +
+
|
+
+ 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 |
- ||
| + + | ++ | +
+ 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.
- |
- ||
| + + | +
+
|
+
+ 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
-
- |
- - | -
- A list of security groups to apply to the elb
- |
+ / elements=string
+
+ + | +
+ A list of security groups to apply to the elb
+ |
| + | ||||
|
security_group_names
list
-
- |
- - | -
- A list of security group names to apply to the elb
- |
+ / 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.
- aliases: access_token |
- ||
| + + | ++ | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
+ ||
|
state
string
- / required
- |
-
-
|
-
- Create or destroy the ELB
- |
- ||
| + / required + | +
+
|
+
+ Create or destroy the ELB
+ |
+ ||
|
stickiness
dictionary
-
- |
- - | -
- An associative array of stickiness policy settings. Policy will be applied to all listeners ( see example )
- |
+
+
+ + | +
+ An associative array of stickiness policy settings. Policy will be applied to all listeners ( see example )
+ |
| + | ||||
|
subnets
list
-
- |
- - | -
- A list of VPC subnets to use when creating ELB. Zones should be empty if using this.
- |
+ / 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.
- |
+
+
+ + | +
+ 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 boto versions >= 2.6.0. |
- ||
| + + | +
+
|
+
+ When set to
+ no, SSL certificates will not be validated for boto versions >= 2.6.0. |
+ ||
|
wait
boolean
-
- |
-
-
|
-
- When specified, Ansible will check the status of the load balancer to ensure it has been successfully removed from AWS.
- |
- ||
| + + | +
+
|
+
+ 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.
- |
- ||
| + + | +
+ 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
-
- |
- - | -
- List of availability zones to enable on this ELB
- |
-
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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_elbs
list
-
- |
- - | -
- List of ELB names, required for registration. The ec2_elbs fact should be used if there was a previous de-register.
- |
+ / elements=string
+
+ + | +
+ List of ELB names, required for registration. The ec2_elbs fact should be used if there was a previous de-register.
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
enable_availability_zone
boolean
-
- |
-
-
|
-
- Whether to enable the availability zone of the instance on the target ELB if the availability zone has not already been enabled. If set to no, the task will fail if the availability zone is not enabled on the ELB.
- |
+
+
+
+
|
+
+ Whether to enable the availability zone of the instance on the target ELB if the availability zone has not already been enabled. If set to no, the task will fail if the availability zone is not enabled on the ELB.
+ |
| + | ||||
|
instance_id
string
- / required
- |
- - | -
- EC2 Instance ID
- |
+ / required
+
+ + | +
+ EC2 Instance ID
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
- / required
- |
-
-
|
-
- register or deregister the instance
- |
+ / required
+
+
+
|
+
+ register or deregister the instance
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
wait
boolean
-
- |
-
-
|
-
- Wait for instance registration or deregistration to complete successfully before returning.
- |
+
+
+
+
|
+
+ Wait for instance registration or deregistration to complete successfully before returning.
+ |
| + | ||||
|
wait_timeout
integer
-
- |
-
- Default: 0
- |
-
- Number of seconds to wait for an instance to change state. If 0 then this module may return an error if a transient error occurs. If non-zero then any transient errors are ignored until the timeout is reached. Ignored when wait=no.
- |
+
+
+
+ Default: 0
+ |
+
+ Number of seconds to wait for an instance to change state. If 0 then this module may return an error if a transient error occurs. If non-zero then any transient errors are ignored until the timeout is reached. Ignored when wait=no.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |||
|---|---|---|---|---|---|---|
| + | ||||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
||
| + | ||||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
||
| + | ||||||
|
cross_zone_load_balancing
boolean
-
- |
-
-
|
-
- Indicates whether cross-zone load balancing is enabled.
- |
+
+
+
+
|
+
+ Indicates whether cross-zone load balancing is enabled.
+ |
||
| + | ||||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
||
| + | ||||||
|
deletion_protection
boolean
-
- |
-
-
|
-
- Indicates whether deletion protection for the ELB is enabled.
- |
+
+
+
+
|
+
+ Indicates whether deletion protection for the ELB is enabled.
+ |
||
| + | ||||||
|
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.
- |
+
+
+ + | +
+ 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 |
||
| + | ||||||
|
listeners
list
- / elements=dictionary
- |
- - | -
- 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.
- |
+ / elements=dictionary
+
+ + | +
+ 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.
+ |
||
| - | + | |||||
| + |
Certificates
list
- / elements=dictionary
- |
- - | -
- The SSL server certificate.
- |
+ / elements=dictionary
+
+ + | +
+ The SSL server certificate.
+ |
|
| - | - | + | ||||
| + | + |
CertificateArn
string
-
- |
- - | -
- The Amazon Resource Name (ARN) of the certificate.
- |
+
+
+ + | +
+ The Amazon Resource Name (ARN) of the certificate.
+ |
| - | + + | |||||
| + |
DefaultActions
list
- / elements=dictionary / required
- |
- - | -
- The default actions for the listener.
- |
+ / elements=dictionary / required
+
+ + | +
+ The default actions for the listener.
+ |
|
| - | - | + | ||||
| + | + |
TargetGroupArn
string
-
- |
- - | -
- The Amazon Resource Name (ARN) of the target group.
- |
+
+
+ + | +
+ The Amazon Resource Name (ARN) of the target group.
+ |
| - | - | + | ||||
| + | + |
Type
string
-
- |
- - | -
- The type of action.
- |
+
+
+ + | +
+ The type of action.
+ |
| - | + + | |||||
| + |
Port
integer
- / required
- |
- - | -
- The port on which the load balancer is listening.
- |
+ / required
+
+ + | +
+ The port on which the load balancer is listening.
+ |
|
| - | + | |||||
| + |
Protocol
string
- / required
- |
- - | -
- The protocol for connections from clients to the load balancer.
- |
+ / required
+
+ + | +
+ The protocol for connections from clients to the load balancer.
+ |
|
| - | + | |||||
| + |
SslPolicy
string
-
- |
- - | -
- The security policy that defines which ciphers and protocols are supported.
- |
+
+
+ + | +
+ The security policy that defines which ciphers and protocols are supported.
+ |
|
| + + | ||||||
|
name
string
- / required
- |
- - | -
- 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.
- |
+ / required
+
+ + | +
+ 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.
+ |
||
| + | ||||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
||
| + | ||||||
|
purge_listeners
boolean
-
- |
-
-
|
-
- If purge_listeners=true, existing listeners will be purged from the ELB to match exactly what is defined by listeners parameter.
- If the listeners parameter is not set then listeners will not be modified.
- |
+
+
+
+
|
+
+ If purge_listeners=true, existing listeners will be purged from the ELB to match exactly what is defined by listeners parameter.
+ If the listeners parameter is not set then listeners will not be modified.
+ |
||
| + | ||||||
|
purge_tags
boolean
-
- |
-
-
|
-
- If purge_tags=true, existing tags will be purged from the resource to match exactly what is defined by tags parameter.
- If the tags parameter is not set then tags will not be modified.
- |
+
+
+
+
|
+
+ If purge_tags=true, existing tags will be purged from the resource to match exactly what is defined by tags parameter.
+ If the tags parameter is not set then tags will not be modified.
+ |
||
| + | ||||||
|
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 |
+
+
+ + | +
+ 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
-
- |
-
-
|
-
- Internet-facing or internal load balancer. An ELB scheme can not be modified after creation.
- |
+
+
+
+
|
+
+ Internet-facing or internal load balancer. An ELB scheme can not be modified after creation.
+ |
||
| + | ||||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
||
| + | ||||||
|
state
string
-
- |
-
-
|
-
- Create or destroy the load balancer.
- The current default is
- absent. However, this behavior is inconsistent with other modules and as such the default will change to present in 2.14. To maintain the existing behavior explicitly set state=absent. |
+
+
+
+
|
+
+ Create or destroy the load balancer.
+ The current default is
+ absent. However, this behavior is inconsistent with other modules and as such the default will change to present in 2.14. To maintain the existing behavior explicitly set state=absent. |
||
| + | ||||||
|
subnet_mappings
list
- / elements=dictionary
- |
- - | -
- A list of dicts containing the IDs of the subnets to attach to the load balancer. You can also specify the allocation ID of an Elastic IP to attach to the load balancer. You can specify one Elastic IP address per subnet.
- This parameter is mutually exclusive with subnets.
- |
+ / elements=dictionary
+
+ + | +
+ A list of dicts containing the IDs of the subnets to attach to the load balancer. You can also specify the allocation ID of an Elastic IP to attach to the load balancer. You can specify one Elastic IP address per subnet.
+ This parameter is mutually exclusive with subnets.
+ |
||
| + | ||||||
|
subnets
list
-
- |
- - | -
- 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 when state=present.
- This parameter is mutually exclusive with subnet_mappings.
- |
+ / elements=string
+
+ + | +
+ 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 when state=present.
+ This parameter is mutually exclusive with subnet_mappings.
+ |
||
| + | ||||||
|
tags
dictionary
-
- |
- - | -
- A dictionary of one or more tags to assign to the load balancer.
- |
+
+
+ + | +
+ A dictionary of one or more tags to assign to the load balancer.
+ |
||
| + | ||||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
||
| + | ||||||
|
wait
boolean
-
- |
-
-
|
-
- Whether or not to wait for the network load balancer to reach the desired state.
- |
+
+
+
+
|
+
+ Whether or not to wait for the network load balancer to reach the desired state.
+ |
||
| + | ||||||
|
wait_timeout
integer
-
- |
- - | -
- The duration in seconds to wait, used in conjunction with wait.
- |
+
+
+ + | +
+ The duration in seconds to wait, used in conjunction with wait.
+ |
||
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
collect_targets_health
boolean
-
- |
-
-
|
-
- When set to "yes", output contains targets health description
- |
+
+
+
+
|
+
+ When set to "yes", output contains targets health description
+ |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
load_balancer_arn
string
-
- |
- - | -
- The Amazon Resource Name (ARN) of the load balancer.
- |
+
+
+ + | +
+ The Amazon Resource Name (ARN) of the load balancer.
+ |
| + | ||||
|
names
list
-
- |
- - | -
- The names of the target groups.
- |
+ / elements=string
+
+ + | +
+ The names of the target groups.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
target_group_arns
list
-
- |
- - | -
- The Amazon Resource Names (ARN) of the target groups.
- |
+ / elements=string
+
+ + | +
+ The Amazon Resource Names (ARN) of the target groups.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
-
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
+
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
+ |
| + | ||||
|
deregistration_delay_timeout
integer
-
- |
- - | -
- The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds.
- |
+
+
+ + | +
+ The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds.
+ |
| + | ||||
|
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.
- |
+
+
+ + | +
+ 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_interval
integer
-
- |
- - | -
- The approximate amount of time, in seconds, between health checks of an individual target.
- |
+
+
+ + | +
+ The approximate amount of time, in seconds, between health checks of an individual target.
+ |
| + | ||||
|
health_check_path
string
-
- |
- - | -
- The ping path that is the destination on the targets for health checks. The path must be defined in order to set a health check.
- Requires the health_check_protocol parameter to be set.
- |
+
+
+ + | +
+ The ping path that is the destination on the targets for health checks. The path must be defined in order to set a health check.
+ Requires the health_check_protocol parameter to be set.
+ |
| + | ||||
|
health_check_port
string
-
- |
- - | -
- The port the load balancer uses when performing health checks on targets. Can be set to 'traffic-port' to match target port.
- When not defined will default to the port on which each target receives traffic from the load balancer.
- |
+
+
+ + | +
+ The port the load balancer uses when performing health checks on targets. Can be set to 'traffic-port' to match target port.
+ When not defined will default to the port on which each target receives traffic from the load balancer.
+ |
| + | ||||
|
health_check_protocol
string
-
- |
-
-
|
-
- The protocol the load balancer uses when performing health checks on targets.
- |
+
+
+
+
|
+
+ The protocol the load balancer uses when performing health checks on targets.
+ |
| + | ||||
|
health_check_timeout
integer
-
- |
- - | -
- The amount of time, in seconds, during which no response from a target means a failed health check.
- |
+
+
+ + | +
+ The amount of time, in seconds, during which no response from a target means a failed health check.
+ |
| + | ||||
|
healthy_threshold_count
integer
-
- |
- - | -
- The number of consecutive health checks successes required before considering an unhealthy target healthy.
- |
+
+
+ + | +
+ The number of consecutive health checks successes required before considering an unhealthy target healthy.
+ |
| + | ||||
|
modify_targets
boolean
-
- |
-
-
|
-
- Whether or not to alter existing targets in the group to match what is passed with the module
- |
+
+
+
+
|
+
+ Whether or not to alter existing targets in the group to match what is passed with the module
+ |
| + | ||||
|
name
string
- / required
- |
- - | -
- The name of the target group.
- |
+ / required
+
+ + | +
+ The name of the target group.
+ |
| + | ||||
|
port
integer
-
- |
- - | -
- The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. Required if state is
- present. |
+
+
+ + | +
+ The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. Required if state is
+ present. |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
protocol
string
-
- |
-
-
|
-
- The protocol to use for routing traffic to the targets. Required when state is
- present. |
+
+
+
+
|
+
+ The protocol to use for routing traffic to the targets. Required when state is
+ present. |
| + | ||||
|
purge_tags
boolean
-
- |
-
-
|
-
- If yes, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tag parameter is not set then tags will not be modified.
- |
+
+
+
+
|
+
+ If yes, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tag parameter is not set then tags will not be modified.
+ |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
state
string
- / required
- |
-
-
|
-
- Create or destroy the target group.
- |
+ / required
+
+
+
|
+
+ Create or destroy the target group.
+ |
| + | ||||
|
stickiness_enabled
boolean
-
- |
-
-
|
-
- Indicates whether sticky sessions are enabled.
- |
+
+
+
+
|
+
+ Indicates whether sticky sessions are enabled.
+ |
| + | ||||
|
stickiness_lb_cookie_duration
integer
-
- |
- - | -
- The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds).
- |
+
+
+ + | +
+ The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds).
+ |
| + | ||||
|
stickiness_type
string
-
- |
- - | -
- The type of sticky sessions.
- If not set AWS will default to
- lb_cookie for Application Load Balancers or source_ip for Network Load Balancers. |
+
+
+ + | +
+ The type of sticky sessions.
+ If not set AWS will default to
+ lb_cookie for Application Load Balancers or source_ip for Network Load Balancers. |
| + | ||||
|
successful_response_codes
string
-
- |
- - | -
- The HTTP codes to use when checking for a successful response from a target.
- Accepts multiple values (for example, "200,202") or a range of values (for example, "200-299").
- Requires the health_check_protocol parameter to be set.
- |
+
+
+ + | +
+ The HTTP codes to use when checking for a successful response from a target.
+ Accepts multiple values (for example, "200,202") or a range of values (for example, "200-299").
+ Requires the health_check_protocol parameter to be set.
+ |
| + | ||||
|
tags
dictionary
-
- |
- - | -
- A dictionary of one or more tags to assign to the target group.
- |
+
+
+ + | +
+ A dictionary of one or more tags to assign to the target group.
+ |
| + | ||||
|
target_type
string
-
- |
-
-
|
-
- The type of target that you must specify when registering targets with this target group. The possible values are
- instance (targets are specified by instance ID), ip (targets are specified by IP address) or lambda (target is specified by ARN). Note that you can't specify targets for a target group using more than one type. Target type lambda only accept one target. When more than one target is specified, only the first one is used. All additional targets are ignored. If the target type is ip, specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.The default behavior is
- instance. |
+
+
+
+
|
+
+ The type of target that you must specify when registering targets with this target group. The possible values are
+ instance (targets are specified by instance ID), ip (targets are specified by IP address) or lambda (target is specified by ARN). Note that you can't specify targets for a target group using more than one type. Target type lambda only accept one target. When more than one target is specified, only the first one is used. All additional targets are ignored. If the target type is ip, specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.The default behavior is
+ instance. |
| + | ||||
|
targets
list
-
- |
- - | -
- A list of targets to assign to the target group. This parameter defaults to an empty list. Unless you set the 'modify_targets' parameter then all existing targets will be removed from the group. The list should be an Id and a Port parameter. See the Examples for detail.
- |
+ / elements=dictionary
+
+ + | +
+ A list of targets to assign to the target group. This parameter defaults to an empty list. Unless you set the 'modify_targets' parameter then all existing targets will be removed from the group. The list should be an Id and a Port parameter. See the Examples for detail.
+ |
| + | ||||
|
unhealthy_threshold_count
integer
-
- |
- - | -
- The number of consecutive health check failures required before considering a target unhealthy.
- |
+
+
+ + | +
+ The number of consecutive health check failures required before considering a target unhealthy.
+ |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| + | ||||
|
vpc_id
string
-
- |
- - | -
- The identifier of the virtual private cloud (VPC). Required when state is
- present. |
+
+
+ + | +
+ The identifier of the virtual private cloud (VPC). Required when state is
+ present. |
| + | ||||
|
wait
boolean
-
- |
-
-
|
-
- Whether or not to wait for the target group.
- |
+
+
+
+
|
+
+ Whether or not to wait for the target group.
+ |
| + | ||||
|
wait_timeout
integer
-
- |
-
- Default: 200
- |
-
- The time to wait for the target group.
- |
+
+
+
+ Default: 200
+ |
+
+ The time to wait for the target group.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
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.
- |
+
+
+
+
|
+
+ 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.
- |
+
+
+ + | +
+ 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 |
| + | ||||
|
get_unused_target_groups
boolean
-
- |
-
-
|
-
- Whether or not to get target groups not used by any load balancers.
- |
+
+
+
+
|
+
+ Whether or not to get target groups not used by any load balancers.
+ |
| + | ||||
|
instance_id
string
- / required
- |
- - | -
- What instance ID to get information for.
- |
+ / required
+
+ + | +
+ What instance ID to get information for.
+ |
| + | ||||
|
profile
string
-
- |
- - | -
- Uses a boto profile. Only works with boto >= 2.24.0.
- |
+
+
+ + | +
+ Uses a boto profile. Only works with boto >= 2.24.0.
+ aliases: aws_profile |
| + | ||||
|
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 |
+
+
+ + | +
+ 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 |
| + | ||||
|
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.
- aliases: access_token |
+
+
+ + | +
+ AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+ aliases: aws_security_token, access_token |
| + | ||||
|
validate_certs
boolean
-
- |
-
-
|
-
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
- |
+
+
+
+
|
+
+ When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
+ |
| Parameter | Choices/Defaults | -Comments | +Comments | |
|---|---|---|---|---|
| + | ||||
|
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.
- aliases: ec2_access_key, access_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_access_key, access_key |
| + | ||||
|
+
+ aws_ca_bundle
+
+
+ path
+
+ |
+ + | +
+ The location of a CA Bundle to use when validating SSL certificates.
+ Only used for boto3 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.
- |
+
+
+ + | +
+ 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.
- aliases: ec2_secret_key, secret_key |
+
+
+ + | +
+ 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.
+ aliases: ec2_secret_key, secret_key |
| + | ||||
|
debug_botocore_endpoint_logs
boolean
-
- |
-
-
|