iam_password_policy – Update an IAM Password Policy¶
New in version 2.8.
Requirements¶
The below requirements are needed on the host that executes this module.
- boto
- boto3
- botocore
- python >= 2.6
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
allow_pw_change
boolean
|
|
Allow users to change their password.
aliases: allow_password_change |
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_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 |
|
debug_botocore_endpoint_logs
boolean
added in 2.8 |
|
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.
|
|
min_pw_length
integer
|
Default: 6
|
Minimum password length.
aliases: minimum_password_length |
profile
string
|
Uses a boto profile. Only works with boto >= 2.24.0.
|
|
pw_expire
boolean
|
|
Prevents users from change an expired password.
aliases: password_expire, expire |
pw_max_age
integer
|
Default: 0
|
Maximum age for a password in days. When this option is 0 then passwords do not expire automatically.
aliases: password_max_age |
pw_reuse_prevent
integer
|
Default: 0
|
Prevent re-use of passwords.
aliases: password_reuse_prevent, prevent_reuse |
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 |
|
require_lowercase
boolean
|
|
Require lowercase letters in password.
|
require_numbers
boolean
|
|
Require numbers in password.
|
require_symbols
boolean
|
|
Require symbols in password.
|
require_uppercase
boolean
|
|
Require uppercase letters in password.
|
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 |
|
state
string
/ required
|
|
Specifies the overall state of the password policy.
|
validate_certs
boolean
|
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|
Notes¶
Note
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URL
orEC2_URL
,AWS_ACCESS_KEY_ID
orAWS_ACCESS_KEY
orEC2_ACCESS_KEY
,AWS_SECRET_ACCESS_KEY
orAWS_SECRET_KEY
orEC2_SECRET_KEY
,AWS_SECURITY_TOKEN
orEC2_SECURITY_TOKEN
,AWS_REGION
orEC2_REGION
- Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION
orEC2_REGION
can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file
Examples¶
- name: Password policy for AWS account
iam_password_policy:
state: present
min_pw_length: 8
require_symbols: false
require_numbers: true
require_uppercase: true
require_lowercase: true
allow_pw_change: true
pw_max_age: 60
pw_reuse_prevent: 5
pw_expire: false
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Aaron Smith (@slapula)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.