Parameter |
Choices/Defaults |
Comments |
access_key_ids
|
|
A list of the keys that you want impacted by the access_key_state parameter.
|
access_key_state
|
Choices:
- create
- remove
- active
- inactive
|
When type is user, it creates, removes, deactivates or activates a user's access key(s). Note that actions apply only to keys specified.
|
aws_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_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
|
ec2_url
|
|
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.
|
groups
|
|
A list of groups the user should belong to. When update, will gracefully remove groups not listed.
|
iam_type
|
|
Type of IAM resource
|
key_count
|
Default:
1
|
When access_key_state is create it will ensure this quantity of keys are present. Defaults to 1.
|
name
required |
|
Name of IAM resource to create or identify
|
new_name
|
|
When state is update, will replace name with new_name on IAM resource
|
new_path
|
|
When state is update, will replace the path with new_path on the IAM resource
|
password
|
|
When type is user and state is present, define the users login password. Also works with update. Note that always returns changed.
|
path
|
Default:
/
|
When creating or updating, specify the desired path of the resource. If state is present, it will replace the current path to match what is passed in when they do not match.
|
profile
(added in 1.6) |
|
Uses a boto profile. Only works with boto >= 2.24.0.
|
region
|
|
aliases: aws_region, ec2_region
|
security_token
(added in 1.6) |
|
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
required |
Choices:
- present
- absent
- update
|
Whether to create, delete or update the IAM resource. Note, roles cannot be updated.
|
trust_policy
(added in 2.2) |
|
The inline (JSON or YAML) trust policy document that grants an entity permission to assume the role. Mutually exclusive with trust_policy_filepath .
|
trust_policy_filepath
(added in 2.2) |
|
The path to the trust policy document that grants an entity permission to assume the role. Mutually exclusive with trust_policy .
|
update_password
|
Choices:
always ←
- on_create
|
always will update passwords if they differ. on_create will only set the password for newly created users.
|
validate_certs
bool
(added in 1.5) |
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|