software.amazon.awssdk.services.iam.model

Interface PasswordPolicy.Builder

All Superinterfaces:

Buildable, CopyableBuilder<PasswordPolicy.Builder,PasswordPolicy>, SdkBuilder<PasswordPolicy.Builder,PasswordPolicy>, SdkPojo

Enclosing class:

PasswordPolicy

public static interface PasswordPolicy.Builder
extends SdkPojo, CopyableBuilder<PasswordPolicy.Builder,PasswordPolicy>

Method Summary

Modifier and Type	Method and Description
PasswordPolicy.Builder	allowUsersToChangePassword(Boolean allowUsersToChangePassword) Specifies whether IAM users are allowed to change their own password.
PasswordPolicy.Builder	expirePasswords(Boolean expirePasswords) Indicates whether passwords in the account expire.
PasswordPolicy.Builder	hardExpiry(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.
PasswordPolicy.Builder	maxPasswordAge(Integer maxPasswordAge) The number of days that an IAM user password is valid.
PasswordPolicy.Builder	minimumPasswordLength(Integer minimumPasswordLength) Minimum length to require for IAM user passwords.
PasswordPolicy.Builder	passwordReusePrevention(Integer passwordReusePrevention) Specifies the number of previous passwords that IAM users are prevented from reusing.
PasswordPolicy.Builder	requireLowercaseCharacters(Boolean requireLowercaseCharacters) Specifies whether IAM user passwords must contain at least one lowercase character (a to z).
PasswordPolicy.Builder	requireNumbers(Boolean requireNumbers) Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).
PasswordPolicy.Builder	requireSymbols(Boolean requireSymbols) Specifies whether IAM user passwords must contain at least one of the following symbols:
PasswordPolicy.Builder	requireUppercaseCharacters(Boolean requireUppercaseCharacters) Specifies whether IAM user passwords must contain at least one uppercase character (A to Z).

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

minimumPasswordLength

PasswordPolicy.Builder minimumPasswordLength(Integer minimumPasswordLength)

Minimum length to require for IAM user passwords.

Parameters:

minimumPasswordLength - Minimum length to require for IAM user passwords.

Returns:

Returns a reference to this object so that method calls can be chained together.

requireSymbols

PasswordPolicy.Builder requireSymbols(Boolean requireSymbols)

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

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

Parameters:

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

requireNumbers

PasswordPolicy.Builder requireNumbers(Boolean requireNumbers)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

requireUppercaseCharacters

PasswordPolicy.Builder requireUppercaseCharacters(Boolean requireUppercaseCharacters)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

requireLowercaseCharacters

PasswordPolicy.Builder requireLowercaseCharacters(Boolean requireLowercaseCharacters)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

allowUsersToChangePassword

PasswordPolicy.Builder allowUsersToChangePassword(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

expirePasswords

PasswordPolicy.Builder expirePasswords(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

maxPasswordAge

PasswordPolicy.Builder maxPasswordAge(Integer maxPasswordAge)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

passwordReusePrevention

PasswordPolicy.Builder passwordReusePrevention(Integer passwordReusePrevention)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

hardExpiry

PasswordPolicy.Builder hardExpiry(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.