Class PasswordPolicy

java.lang.Object
software.amazon.awssdk.services.iam.model.PasswordPolicy
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PasswordPolicy.Builder,PasswordPolicy>
@Generated("software.amazon.awssdk:codegen") public final class PasswordPolicy extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PasswordPolicy.Builder,PasswordPolicy>

Contains information about the account password policy.

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

See Also:

  • Method Details

    • minimumPasswordLength

      public final Integer minimumPasswordLength()

      Minimum length to require for IAM user passwords.

      Returns:
      Minimum length to require for IAM user passwords.

    • requireSymbols

      public final Boolean requireSymbols()

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

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

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

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

    • requireNumbers

      public final Boolean requireNumbers()

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

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

    • requireUppercaseCharacters

      public final Boolean requireUppercaseCharacters()

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

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

    • requireLowercaseCharacters

      public final Boolean requireLowercaseCharacters()

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

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

    • allowUsersToChangePassword

      public final Boolean 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.

      Returns:
      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.

    • expirePasswords

      public final Boolean 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.

      Returns:
      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.

    • maxPasswordAge

      public final Integer maxPasswordAge()

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

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

    • passwordReusePrevention

      public final Integer passwordReusePrevention()

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

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

    • hardExpiry

      public final Boolean 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.

      Returns:
      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.

    • toBuilder

      public PasswordPolicy.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PasswordPolicy.Builder,PasswordPolicy>
      Returns:
      a builder for type T

    • builder

      public static PasswordPolicy.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PasswordPolicy.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.