Documentation

Contains information about the account password policy.

This data type is used as a response element in the GetAccountPasswordPolicy operation.

See: newPasswordPolicy smart constructor.

Create a value of PasswordPolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:allowUsersToChangePassword:PasswordPolicy', passwordPolicy_allowUsersToChangePassword - 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.

$sel:expirePasswords:PasswordPolicy', passwordPolicy_expirePasswords - 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.

$sel:hardExpiry:PasswordPolicy', passwordPolicy_hardExpiry - 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.

$sel:maxPasswordAge:PasswordPolicy', passwordPolicy_maxPasswordAge - The number of days that an IAM user password is valid.

$sel:minimumPasswordLength:PasswordPolicy', passwordPolicy_minimumPasswordLength - Minimum length to require for IAM user passwords.

$sel:passwordReusePrevention:PasswordPolicy', passwordPolicy_passwordReusePrevention - Specifies the number of previous passwords that IAM users are prevented from reusing.

$sel:requireLowercaseCharacters:PasswordPolicy', passwordPolicy_requireLowercaseCharacters - Specifies whether IAM user passwords must contain at least one lowercase character (a to z).

$sel:requireNumbers:PasswordPolicy', passwordPolicy_requireNumbers - Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).

$sel:requireSymbols:PasswordPolicy', passwordPolicy_requireSymbols - Specifies whether IAM user passwords must contain at least one of the following symbols:

! @ # $ % ^ & * ( ) _ + - = [ ] { } | '

$sel:requireUppercaseCharacters:PasswordPolicy', passwordPolicy_requireUppercaseCharacters - Specifies whether IAM user passwords must contain at least one uppercase character (A to Z).

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.

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.

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.

The number of days that an IAM user password is valid.

Minimum length to require for IAM user passwords.

Specifies the number of previous passwords that IAM users are prevented from reusing.

Specifies whether IAM user passwords must contain at least one lowercase character (a to z).

Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).

Specifies whether IAM user passwords must contain at least one of the following symbols:

! @ # $ % ^ & * ( ) _ + - = [ ] { } | '

Specifies whether IAM user passwords must contain at least one uppercase character (A to Z).