Interface UpdateUserRequest.Builder

  • Method Details

    • clientToken

      UpdateUserRequest.Builder clientToken(String clientToken)

      A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call.

      A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.

      If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an ConflictException.

      This parameter is optional when using the CLI or SDK.

      Parameters:
      clientToken - A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call.

      A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.

      If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an ConflictException.

      This parameter is optional when using the CLI or SDK.

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

      UpdateUserRequest.Builder directoryId(String directoryId)

      The identifier (ID) of the directory that's associated with the user.

      Parameters:
      directoryId - The identifier (ID) of the directory that's associated with the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • emailAddress

      UpdateUserRequest.Builder emailAddress(String emailAddress)

      The email address of the user.

      Parameters:
      emailAddress - The email address of the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • givenName

      UpdateUserRequest.Builder givenName(String givenName)

      The first name of the user.

      Parameters:
      givenName - The first name of the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • otherAttributes

      UpdateUserRequest.Builder otherAttributes(Map<String,AttributeValue> otherAttributes)

      An expression that defines one or more attribute names with the data type and value of each attribute. A key is an attribute name, and the value is a list of maps. For a list of supported attributes, see Directory Service Data Attributes.

      Attribute names are case insensitive.

      Parameters:
      otherAttributes - An expression that defines one or more attribute names with the data type and value of each attribute. A key is an attribute name, and the value is a list of maps. For a list of supported attributes, see Directory Service Data Attributes.

      Attribute names are case insensitive.

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

      UpdateUserRequest.Builder samAccountName(String samAccountName)

      The name of the user.

      Parameters:
      samAccountName - The name of the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • surname

      The last name of the user.

      Parameters:
      surname - The last name of the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • updateType

      UpdateUserRequest.Builder updateType(String updateType)

      The type of update to be performed. If no value exists for the attribute, use ADD. Otherwise, use REPLACE to change an attribute value or REMOVE to clear the attribute value.

      Parameters:
      updateType - The type of update to be performed. If no value exists for the attribute, use ADD. Otherwise, use REPLACE to change an attribute value or REMOVE to clear the attribute value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • updateType

      UpdateUserRequest.Builder updateType(UpdateType updateType)

      The type of update to be performed. If no value exists for the attribute, use ADD. Otherwise, use REPLACE to change an attribute value or REMOVE to clear the attribute value.

      Parameters:
      updateType - The type of update to be performed. If no value exists for the attribute, use ADD. Otherwise, use REPLACE to change an attribute value or REMOVE to clear the attribute value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • overrideConfiguration

      UpdateUserRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.