account_password_policies

Creates, updates, deletes, gets or lists an account_password_policies resource.

Overview

Name	account_password_policies
Type	Resource
Id	aws.iam.account_password_policies

Fields

The following fields are returned by SELECT queries:

get_account_password_policy

Name	Datatype	Description
allow_users_to_change_password	boolean	Specifies whether IAM users are allowed to change their own password. Gives IAM users permissions to iam:ChangePassword for only their user and to the iam:GetAccountPasswordPolicy action. This option does not attach a permissions policy to each user, rather the permissions are applied at the account-level for all users by IAM.
expire_passwords	boolean	Indicates whether passwords in the account expire. Returns true if MaxPasswordAge contains a value greater than 0. Returns false if MaxPasswordAge is 0 or not present.
hard_expiry	boolean	Specifies whether IAM users are prevented from setting a new password via the Amazon Web Services Management Console after their password has expired. The IAM user cannot access the console until an administrator resets the password. IAM users with iam:ChangePassword permission and active access keys can reset their own expired console password using the CLI or API.
max_password_age	integer	The number of days that an IAM user password is valid.
minimum_password_length	integer	Minimum length to require for IAM user passwords.
password_reuse_prevention	integer	Specifies the number of previous passwords that IAM users are prevented from reusing.
require_lowercase_characters	boolean	Specifies whether IAM user passwords must contain at least one lowercase character (a to z).
require_numbers	boolean	Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).
require_symbols	boolean	Specifies whether IAM user passwords must contain at least one of the following symbols: ! @ # $ % ^ & * ( ) _ + - = [ ] { } | '
require_uppercase_characters	boolean	Specifies whether IAM user passwords must contain at least one uppercase character (A to Z).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_account_password_policy	select	region		Retrieves the password policy for the Amazon Web Services account. This tells you the complexity requirements and mandatory rotation periods for the IAM user passwords in your account. For more information about using a password policy, see Managing an IAM password policy.
update_account_password_policy	update	region	MinimumPasswordLength, RequireSymbols, RequireNumbers, RequireUppercaseCharacters, RequireLowercaseCharacters, AllowUsersToChangePassword, MaxPasswordAge, PasswordReusePrevention, HardExpiry	Updates the password policy settings for the Amazon Web Services account. This operation does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the Request Parameters section for each parameter's default value. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation. For more information about using a password policy, see Managing an IAM password policy in the IAM User Guide.
delete_account_password_policy	delete	region		Deletes the password policy for the Amazon Web Services account. There are no parameters.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
AllowUsersToChangePassword	boolean	Allows all IAM users in your account to use the Amazon Web Services Management Console to change their own passwords. For more information, see Permitting IAM users to change their own passwords in the IAM User Guide. If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that IAM users in the account do not automatically have permissions to change their own password.
HardExpiry	boolean	Prevents IAM users who are accessing the account via the Amazon Web Services Management Console from setting a new console password after their password has expired. The IAM user cannot access the console until an administrator resets the password. If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that IAM users can change their passwords after they expire and continue to sign in as the user. In the Amazon Web Services Management Console, the custom password policy option Allow users to change their own password gives IAM users permissions to iam:ChangePassword for only their user and to the iam:GetAccountPasswordPolicy action. This option does not attach a permissions policy to each user, rather the permissions are applied at the account-level for all users by IAM. IAM users with iam:ChangePassword permission and active access keys can reset their own expired console password using the CLI or API.
MaxPasswordAge	integer	The number of days that an IAM user password is valid. If you do not specify a value for this parameter, then the operation uses the default value of 0. The result is that IAM user passwords never expire.
MinimumPasswordLength	integer	The minimum number of characters allowed in an IAM user password. If you do not specify a value for this parameter, then the operation uses the default value of 6.
PasswordReusePrevention	integer	Specifies the number of previous passwords that IAM users are prevented from reusing. If you do not specify a value for this parameter, then the operation uses the default value of 0. The result is that IAM users are not prevented from reusing previous passwords.
RequireLowercaseCharacters	boolean	Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z). If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one lowercase character.
RequireNumbers	boolean	Specifies whether IAM user passwords must contain at least one numeric character (0 to 9). If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one numeric character.
RequireSymbols	boolean	Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters: ! @ # $ % ^ & * ( ) _ + - = [ ] { } | ' If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one symbol character.
RequireUppercaseCharacters	boolean	Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z). If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one uppercase character.

SELECT examples

get_account_password_policy

Retrieves the password policy for the Amazon Web Services account. This tells you the complexity requirements and mandatory rotation periods for the IAM user passwords in your account. For more information about using a password policy, see Managing an IAM password policy.

SELECT
allow_users_to_change_password,
expire_passwords,
hard_expiry,
max_password_age,
minimum_password_length,
password_reuse_prevention,
require_lowercase_characters,
require_numbers,
require_symbols,
require_uppercase_characters
FROM aws.iam.account_password_policies
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_account_password_policy

Updates the password policy settings for the Amazon Web Services account. This operation does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the Request Parameters section for each parameter's default value. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation. For more information about using a password policy, see Managing an IAM password policy in the IAM User Guide.

UPDATE aws.iam.account_password_policies
SET 
-- No updatable properties
WHERE 
region = '{{ region }}' --required
AND MinimumPasswordLength = '{{ MinimumPasswordLength}}'
AND RequireSymbols = {{ RequireSymbols}}
AND RequireNumbers = {{ RequireNumbers}}
AND RequireUppercaseCharacters = {{ RequireUppercaseCharacters}}
AND RequireLowercaseCharacters = {{ RequireLowercaseCharacters}}
AND AllowUsersToChangePassword = {{ AllowUsersToChangePassword}}
AND MaxPasswordAge = '{{ MaxPasswordAge}}'
AND PasswordReusePrevention = '{{ PasswordReusePrevention}}'
AND HardExpiry = {{ HardExpiry}};

DELETE examples

delete_account_password_policy

Deletes the password policy for the Amazon Web Services account. There are no parameters.

DELETE FROM aws.iam.account_password_policies
WHERE region = '{{ region }}' --required
;